Struct BindingExpression 

pub struct BindingExpression { /* private fields */ }

A binding expression which accepts and produces (possibly boxed) untyped values: a source, a path of expression nodes read from it, and the conversion of the result to the target.

Implementations

impl BindingExpression

pub fn new( source: Option<BoxedValue>, nodes: Vec<Rc<dyn ExpressionNode>>, options: BindingExpressionOptions, ) -> Rc<Self>

Creates a binding expression.

source is the object from which the value is read (null is None); nodes represent the binding path.

pub fn source_type(&self) -> Option<ValueType>

The type of the value accepted by the binding source, if it can be written.

pub fn converter(&self) -> Option<&Rc<dyn IValueConverter>>

pub fn converter_culture(&self) -> CultureInfo

The culture in which the converter is evaluated: the converter culture of the binding, or the current culture when it names none.

pub fn converter_parameter(&self) -> Option<&BoxedValue>

pub fn fallback_value(&self) -> Option<BoxedValue>

The fallback value; the unset marker if there is none.

pub fn leaf_node(&self) -> Option<&Rc<dyn ExpressionNode>>

pub fn nodes(&self) -> &[Rc<dyn ExpressionNode>]

pub fn mode(&self) -> BindingMode

pub fn string_format(&self) -> Option<&str>

pub fn target_null_value(&self) -> Option<BoxedValue>

The target null value; the unset marker if there is none.

pub fn delay(&self) -> Duration

The amount of time to wait before updating the binding source after the value on the target changes.

pub fn update_source_trigger(&self) -> UpdateSourceTrigger

pub fn error_type(&self) -> BindingErrorType

The current error state of the binding expression.

pub fn to_observable( self: &Rc<Self>, target: Option<&FerroObject>, ) -> Rc<ObservableSink>

Produces an observable subject over the expression, see ObservableSink.

Trait Implementations

impl BindingExpressionBase for BindingExpression

fn priority(&self) -> BindingPriority

The priority of the binding expression.

fn target_property(&self) -> Option<&'static FerroProperty>

The property that the binding expression is targeting.

fn default_priority(&self) -> BindingPriority

The preferred priority of the binding expression; the priority passed to attach may differ if the binding targets a direct property, in which case it is elevated to local value priority.

fn is_data_validation_enabled(&self) -> bool

Whether data validation is enabled for the binding expression.

fn update_source(&self)

Sends the current binding target value to the binding source property in two-way or one-way-to-source bindings. Does nothing for other modes. If the update source trigger of the binding is explicit, this must be called for changes to propagate back to the source.

fn update_target(&self)

Forces a data transfer from the binding source to the binding target.

fn as_any(&self) -> &dyn Any

impl Drop for BindingExpression

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl IDisposable for BindingExpression

fn dispose(&self)

impl UntypedBindingExpression for BindingExpression

fn base(&self) -> &UntypedBindingExpressionBase

fn description(&self) -> String

A description of the binding expression.

fn update_source_core(&self)

fn update_target_core(&self)

fn write_value_to_source(&self, value: Option<BoxedValue>) -> bool

Writes the specified value to the binding source if possible. Returns true if the value could be written.

fn should_log_error(&self) -> Option<Ref<FerroObject>>

The target to log errors against, if an error should be logged given the current state of the binding expression.

fn start_core(&self)

Starts the binding expression. Do not call directly; call start.

fn stop_core(&self)

Stops the binding expression. Do not call directly; call stop.

fn start(&self, produce_value: bool)

Starts the binding expression.

fn stop(&self)

Stops the binding expression.

fn dispose_expression(&self)

Terminates the binding.

fn log_error(&self, error: &str, level: LogEventLevel)

Logs a binding error against the target, if there is one.