Struct BindingNotification 

pub struct BindingNotification { /* private fields */ }

Represents a binding notification that can be a valid binding value, or a binding or data validation error.

This type is very similar to BindingValue, but where BindingValue is used by typed bindings, this type is used to hold binding and data validation errors in untyped bindings.

A notification has reference semantics: it is shared as Rc<BindingNotification> (which converts to a BoxedValue holding the notification) and is modified in place.

Implementations

impl BindingNotification

pub fn null() -> Rc<BindingNotification>

A binding notification representing the null value.

pub fn unset_value() -> Rc<BindingNotification>

A binding notification representing the unset value marker.

pub fn new(value: Option<BoxedValue>) -> Self

Creates a binding notification for a binding value.

pub fn with_error(error: BindingError, error_type: BindingErrorType) -> Self

Creates a binding notification for a binding error.

Panics if error_type is BindingErrorType::None.

pub fn with_error_and_fallback( error: BindingError, error_type: BindingErrorType, fallback_value: Option<BoxedValue>, ) -> Self

Creates a binding notification for a binding error with a fallback value.

Panics if error_type is BindingErrorType::None.

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

Gets the value that should be passed to the target when has_value is true.

If this is read when has_value is false then it returns the unset value marker.

pub fn has_value(&self) -> bool

Gets a value indicating whether value should be pushed to the target.

pub fn error(&self) -> Option<BindingError>

Gets the error that occurred on the source, if any.

pub fn set_error(&self, error: Option<BindingError>)

Sets the error that occurred on the source.

pub fn error_type(&self) -> BindingErrorType

Gets the type of error that error represents, if any.

pub fn set_error_type(&self, error_type: BindingErrorType)

Sets the type of error that error represents.

pub fn extract_value(o: Option<&BoxedValue>) -> Option<BoxedValue>

Gets a value from an untyped value that may be a binding notification.

If o is a binding notification then returns the binding notification’s value. If not, returns the value unchanged.

pub fn update_value( o: Option<&BoxedValue>, value: Option<&BoxedValue>, ) -> Option<BoxedValue>

Updates the value of an untyped value that may be a binding notification.

If o is a binding notification then sets its value to value and returns the notification; otherwise returns value. If value is a binding notification then its value is extracted first.

pub fn extract_error(o: Option<&BoxedValue>) -> Option<BoxedValue>

Gets an error from an untyped value that may be a binding notification.

If o is a binding notification then returns the binding notification’s error (boxed as a BindingError). If not, returns the value unchanged.

pub fn add_error(&self, e: BindingError, error_type: BindingErrorType)

Adds an error to the binding notification.

Panics if error_type is BindingErrorType::None.

pub fn clear_value(&self)

Removes the value and makes has_value return false.

pub fn set_value(&self, value: Option<BoxedValue>)

Sets the value.

Trait Implementations

impl Debug for BindingNotification

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

Formats the value using the given formatter.

impl Display for BindingNotification

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

Formats the value using the given formatter.

impl PartialEq for BindingNotification

fn eq(&self, other: &Self) -> bool

Compares two binding notifications for equality.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.