Struct Binding

pub struct Binding { /* private fields */ }

A bound value with metadata.

Implementations

impl Binding

pub fn new(value: impl IntoValue, span: Span) -> Binding

Create a new binding with a span marking its definition site.

pub fn detached(value: impl IntoValue) -> Binding

Create a binding without a span.

pub fn deprecated(&mut self, deprecation: Deprecation) -> &mut Binding

Marks this binding as deprecated, with the given message.

pub fn read(&self) -> &Value

Read the value.

pub fn read_checked(&self, sink: impl DeprecationSink) -> &Value

Read the value, checking for deprecation.

As the sink

• pass () to ignore the message.
• pass (&mut engine, span) to emit a warning into the engine.

pub fn write(&mut self) -> Result<&mut Value, EcoString>

Try to write to the value.

This fails if the value is a read-only closure capture.

pub fn capture(&self, capturer: Capturer) -> Binding

Create a copy of the binding for closure capturing.

pub fn span(&self) -> Span

A span associated with the stored value.

pub fn deprecation(&self) -> Option<&Deprecation>

A deprecation message for the value, if any.

pub fn category(&self) -> Option<Category>

The category of the value, if any.

Trait Implementations

impl Clone for Binding

fn clone(&self) -> Binding

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Binding

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Hash for Binding

fn hash<__H>(&self, state: &mut __H)

where __H: Hasher,

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.