VarEventNodeBuilder

Struct VarEventNodeBuilder 

Source
pub struct VarEventNodeBuilder<I, F, M> { /* private fields */ }
Expand description

Helper for declaring event properties from variables.

Implementations§

Source§

impl<I, T> VarEventNodeBuilder<I, (), ()>
where T: VarValue, I: FnMut() -> Var<T> + Send + 'static,

Source

pub fn new(init_var: I) -> VarEventNodeBuilder<I, (), ()>

Node that calls the handler for var updates.

The init_var is called on init to

Source§

impl<T, I, M> VarEventNodeBuilder<I, (), M>
where T: VarValue, I: FnMut() -> Var<T> + Send + 'static,

Source

pub fn filter<FB, F>(self, filter_builder: FB) -> VarEventNodeBuilder<I, FB, M>
where FB: FnMut() -> F + Send + 'static, F: Fn(&T) -> bool + Send + Sync + 'static,

Filter event.

The filter_builder is called on init and on new, it must produce another closure, the filter predicate. The filter_builder runs in the widget context, the filter predicate does not always.

In the variable hook the filter predicate runs in the app context, it is called if the args target the widget, the predicate must use any captured contextual info to filter the args, this is an optimization, it can save a visit to the widget node.

If the update is received the second filter predicate is called again to confirm the update. If it returns true the handler closure is called.

Source§

impl<T, I, F> VarEventNodeBuilder<I, F, ()>
where T: VarValue, I: FnMut() -> Var<T> + Send + 'static,

Source

pub fn map_args<M, MA>(self, map_args: M) -> VarEventNodeBuilder<I, F, M>
where M: FnMut(&T) -> MA + Send + 'static, MA: Clone + 'static,

Convert args.

The map_args closure is called in context, just before the handler is called.

Note that if the args is a full EventArgs type it must share the same propagation handle in the preview and normal route properties, if the source type is also a full args just clone the propagation handle, otherwise you must use WIDGET::set_state to communicate between the properties.

Source§

impl<T, I, F, FB, MA, M> VarEventNodeBuilder<I, FB, M>
where T: VarValue, I: FnMut() -> Var<T> + Send + 'static, F: Fn(&T) -> bool + Send + Sync + 'static, FB: FnMut() -> F + Send + 'static, MA: Clone + 'static, M: FnMut(&T) -> MA + Send + 'static,

Build with filter and args mapping.

Source

pub fn build<const PRE: bool>( self, child: impl IntoUiNode, handler: Box<dyn FnMut(&MA) -> HandlerResult + Send>, ) -> UiNode

Build node.

If PRE is true the handler is called before the children, preview route.

Source§

impl<T, I, F, FB> VarEventNodeBuilder<I, FB, ()>
where T: VarValue, I: FnMut() -> Var<T> + Send + 'static, F: Fn(&T) -> bool + Send + Sync + 'static, FB: FnMut() -> F + Send + 'static,

Build with filter and without args mapping.

Source

pub fn build<const PRE: bool>( self, child: impl IntoUiNode, handler: Box<dyn FnMut(&T) -> HandlerResult + Send>, ) -> UiNode

Build node.

If PRE is true the handler is called before the children, preview route.

Source§

impl<T, I> VarEventNodeBuilder<I, (), ()>
where T: VarValue, I: FnMut() -> Var<T> + Send + 'static,

Build without filter and without args mapping.

Source

pub fn build<const PRE: bool>( self, child: impl IntoUiNode, handler: Box<dyn FnMut(&T) -> HandlerResult + Send>, ) -> UiNode

Build node.

If PRE is true the handler is called before the children, preview route.

Source§

impl<T, I, MA, M> VarEventNodeBuilder<I, (), M>
where T: VarValue, I: FnMut() -> Var<T> + Send + 'static, MA: Clone + 'static, M: FnMut(&T) -> MA + Send + 'static,

Build with no filter and args mapping.

Source

pub fn build<const PRE: bool>( self, child: impl IntoUiNode, handler: Box<dyn FnMut(&MA) -> HandlerResult + Send>, ) -> UiNode

Build node.

If PRE is true the handler is called before the children, preview route.

Auto Trait Implementations§

§

impl<I, F, M> Freeze for VarEventNodeBuilder<I, F, M>
where I: Freeze, F: Freeze, M: Freeze,

§

impl<I, F, M> RefUnwindSafe for VarEventNodeBuilder<I, F, M>

§

impl<I, F, M> Send for VarEventNodeBuilder<I, F, M>
where I: Send, F: Send, M: Send,

§

impl<I, F, M> Sync for VarEventNodeBuilder<I, F, M>
where I: Sync, F: Sync, M: Sync,

§

impl<I, F, M> Unpin for VarEventNodeBuilder<I, F, M>
where I: Unpin, F: Unpin, M: Unpin,

§

impl<I, F, M> UnwindSafe for VarEventNodeBuilder<I, F, M>
where I: UnwindSafe, F: UnwindSafe, M: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<T> Downcast for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<S> FromSample<S> for S

§

fn from_sample_(s: S) -> S

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

§

fn into_sample(self) -> T

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

§

fn to_sample_(self) -> U

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> StateValue for T
where T: Any + Send + Sync,