Struct CompiledBindingPathBuilder 

pub struct CompiledBindingPathBuilder { /* private fields */ }

Builds a CompiledBindingPath.

The builder is a reference object: a shared handle to the elements collected so far. Every method adds an element and returns the builder (another handle to it), so that calls can be chained, as well as made one by one through any clone of the handle. Handles compare by identity.

Implementations

impl CompiledBindingPathBuilder

pub fn new() -> Self

pub fn not(&self) -> Self

Negates the result of the path.

pub fn ferro_property(&self, property: &'static FerroProperty) -> Self

A registered property of an object of the class hierarchy.

pub fn ferro_property_with( &self, property: &'static FerroProperty, accepts_null: bool, ) -> Self

A registered property of an object of the class hierarchy. accepts_null applies a null-conditional operator to the access: a null owner produces null instead of an error.

pub fn property( &self, info: Rc<dyn IPropertyInfo>, accessor_factory: PropertyAccessorFactory, ) -> Self

A plain property, from its description and the factory of its accessor.

pub fn property_with( &self, info: Rc<dyn IPropertyInfo>, accessor_factory: PropertyAccessorFactory, accepts_null: bool, ) -> Self

A plain property. accepts_null applies a null-conditional operator to the access: a null owner produces null instead of an error.

pub fn typed_property<S: INotifyPropertyChanged + PartialEq + 'static, V: PropertyValue>( &self, name: &str, get: impl Fn(&S) -> V + 'static, set: Option<Rc<dyn Fn(&S, V)>>, ) -> Self

A property with typed accessors on a model type that raises property change notifications. A binding whose path is this single element, bound to a target property of exactly type V, reads and writes values without boxing them.

pub fn notifying_property<O: INotifyPropertyChanged + PartialEq + 'static, K: PropertyKind>( &self, name: &str, get: impl Fn(&O) -> K::Typed + 'static, set: impl Fn(&O, K::Typed) + 'static, ) -> Self

A read-write property of a model type that raises property change notifications, from typed accessors.

pub fn notifying_read_only_property<O: INotifyPropertyChanged + PartialEq + 'static, K: PropertyKind>( &self, name: &str, get: impl Fn(&O) -> K::Typed + 'static, ) -> Self

A read-only property of a model type that raises property change notifications, from a typed getter.

pub fn command<O: 'static>( &self, method_name: &str, execute: impl Fn(&O, Option<&BoxedValue>) + 'static, can_execute: Option<Rc<dyn Fn(&O, Option<&BoxedValue>) -> bool>>, depends_on_properties: &[&str], ) -> Self

A method used as a command.

pub fn notifying_command<O: INotifyPropertyChanged + 'static>( &self, method_name: &str, execute: impl Fn(&O, Option<&BoxedValue>) + 'static, can_execute: Option<Rc<dyn Fn(&O, Option<&BoxedValue>) -> bool>>, depends_on_properties: &[&str], ) -> Self

A method used as a command on an owner that raises property change notifications: the command’s state is re-queried when one of depends_on_properties changes.

pub fn stream_task(&self) -> Self

Streams the outcome of a task (^).

pub fn stream_observable(&self) -> Self

Streams the values of an observable (^).

pub fn stream(&self, plugin: Rc<dyn IStreamPlugin>) -> Self

Streams values through a custom stream plugin.

pub fn self_(&self) -> Self

Roots the path at the binding target itself ($self).

pub fn ancestor( &self, ancestor_type: Option<&'static TypeInfo>, level: usize, ) -> Self

Roots the path at an ancestor in the logical tree.

pub fn visual_ancestor( &self, ancestor_type: Option<&'static TypeInfo>, level: usize, ) -> Self

Roots the path at an ancestor in the visual tree.

pub fn element_name(&self, name_scope: NameScopeRef, name: &str) -> Self

Roots the path at a named element.

pub fn indexer_property<O: 'static, K: PropertyKind>( &self, index: i32, get: impl Fn(&O, i32) -> Result<K::Typed, BindingError> + 'static, set: Option<Rc<dyn Fn(&O, i32, K::Typed) -> Result<(), BindingError>>>, ) -> Self

An indexer with one integer argument (owner[index]) on owner type O, from typed accessors that fail for a bad index. The value is re-read when the owner raises a collection change that affects index, or a property change for the indexer.

pub fn list_item<T: PropertyValue>(&self, index: i32) -> Self

The item at index of a BindableList (list[index]).

pub fn dictionary_item<K: Eq + Hash + Clone + Display + 'static, V: PropertyValue>( &self, key: K, ) -> Self

The entry for key of a BindableDictionary (dictionary[key]). Reading a missing key is an error; writing adds the entry.

pub fn array_element(&self, indices: &[i32]) -> Self

Indexes an array with integer indexes, one per dimension.

pub fn type_cast<T: ObjectType>(&self) -> Self

Casts to class T: passes an object on if it is a T, else null.

pub fn type_cast_value(&self, target: CastTarget) -> Self

Casts to a class, or to a value or model type: passes a value on if it is an instance of the type (CastTarget::is_instance), else null.

pub fn templated_parent(&self) -> Self

Roots the path at the templated parent of the binding target.

pub fn property_untyped( &self, name: &str, property_type: ValueType, get: UntypedGetter, set: Option<UntypedSetter>, notifier: Option<AsNotifyPropertyChanged>, ) -> Self

A property whose accessors are closures over untyped values: get reads it from the handle of its owner, set (if the property can be written) writes it, and notifier (if the owner raises property change notifications) views the owner as a notifier. property_type is the type of the property’s value.

pub fn property_untyped_with( &self, name: &str, property_type: ValueType, get: UntypedGetter, set: Option<UntypedSetter>, notifier: Option<AsNotifyPropertyChanged>, accepts_null: bool, ) -> Self

As property_untyped. accepts_null applies a null-conditional operator to the access: a null owner produces null instead of an error.

pub fn command_untyped( &self, method_name: &str, execute: UntypedExecute, can_execute: Option<UntypedCanExecute>, depends_on_properties: &[&str], notifier: Option<AsNotifyPropertyChanged>, ) -> Self

A method used as a command, from closures over the handle of the owner. The command’s state is re-queried when the owner (viewed as a notifier by notifier) reports a change of one of depends_on_properties.

pub fn method_untyped( &self, name: &str, create_delegate: UntypedCreateDelegate, accepts_null: bool, ) -> Self

A method as a delegate value: the path element produces the value create_delegate makes for the handle of the owner, usually an untyped callback (MarkupDelegate) that invokes the method on it. accepts_null applies a null-conditional operator to the access: a null owner produces null instead of an error.

pub fn typed_plain_property_info_with<S: PartialEq + 'static, V: PropertyValue>( &self, info: TypedClrPropertyInfo<S, V>, accepts_null: bool, ) -> Self

A property with typed accessors on a shared model type that raises NO property change notifications: as typed_property_info_with, with the value read once per source (the typed property overload of the managed original does not require a notifying source).

pub fn build(&self) -> CompiledBindingPath

The path of the elements added so far.

pub fn typed_property_info<S: INotifyPropertyChanged + PartialEq + 'static, V: PropertyValue>( &self, info: TypedClrPropertyInfo<S, V>, ) -> Self

As typed_property, from a property description (which may have a fallible getter).

pub fn typed_property_info_with<S: INotifyPropertyChanged + PartialEq + 'static, V: PropertyValue>( &self, info: TypedClrPropertyInfo<S, V>, accepts_null: bool, ) -> Self

As typed_property_info. accepts_null applies a null-conditional operator to the access (the three argument Property<TSource, TValue> of the managed original).

Trait Implementations

impl Clone for CompiledBindingPathBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for CompiledBindingPathBuilder

fn default() -> Self

Returns the “default value” for a type.

impl MarkupTyped for CompiledBindingPathBuilder

const MARKUP: &'static MarkupType

The markup metadata of the type.

impl PartialEq for CompiledBindingPathBuilder

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

Equality operator ==.

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

Inequality operator !=.