Struct CallbackRef

pub struct CallbackRef<IN, OUT = ()> { /* private fields */ }

Universal callback wrapper with reference in argument.

An Rc wrapper is used to make it cloneable.

Implementations

impl<IN, OUT> CallbackRef<IN, OUT>

pub fn emit(&self, value: &IN) -> OUT

This method calls the callback’s function.

impl<IN> CallbackRef<IN>

pub fn noop() -> Self

Creates a “no-op” callback which can be used when it is not suitable to use an Option<$callback>.

impl<IN: 'static, OUT: 'static> CallbackRef<IN, OUT>

pub fn reform<F, T>(&self, func: F) -> Callback<T, OUT>

where F: Fn(T) -> IN + 'static,

Creates a new Callback from another callback and a function.

That when emitted will call that function and will emit the original callback

pub fn reform_ref<F, T>(&self, func: F) -> CallbackRef<T, OUT>

where F: Fn(&T) -> &IN + 'static,

Creates a new CallbackRef from another callback and a function.

That when emitted will call that function and will emit the original callback

pub fn reform_ref_mut<F, T>(&self, func: F) -> CallbackRefMut<T, OUT>

where F: Fn(&mut T) -> &IN + 'static,

Creates a new CallbackRefMut from another callback and a function.

That when emitted will call that function and will emit the original callback

pub fn filter_reform<F, T>(&self, func: F) -> Callback<T, Option<OUT>>

where F: Fn(T) -> Option<IN> + 'static,

Creates a new Callback from another callback and a function.

When emitted will call the function and, only if it returns Some(value), will emit value to the original callback.

pub fn filter_reform_ref<F, T>(&self, func: F) -> CallbackRef<T, Option<OUT>>

where F: Fn(&T) -> Option<&IN> + 'static,

Creates a new CallbackRef from another callback and a function.

When emitted will call the function and, only if it returns Some(value), will emit value to the original callback.

pub fn filter_reform_ref_mut<F, T>( &self, func: F, ) -> CallbackRefMut<T, Option<OUT>>

where F: Fn(&mut T) -> Option<&IN> + 'static,

Creates a new CallbackRefMut from another callback and a function.

When emitted will call the function and, only if it returns Some(value), will emit value to the original callback.

Trait Implementations

impl<IN, OUT> Clone for CallbackRef<IN, OUT>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<IN, OUT> Debug for CallbackRef<IN, OUT>

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

Formats the value using the given formatter.

impl<IN> Default for CallbackRef<IN>

fn default() -> Self

Returns the “default value” for a type.

impl<IN, OUT, F: Fn(&IN) -> OUT + 'static> From<F> for CallbackRef<IN, OUT>

fn from(func: F) -> Self

Converts to this type from the input type.

impl<IN, OUT> ImplicitClone for CallbackRef<IN, OUT>

fn implicit_clone(&self) -> Self

This function is not magic; it is literally defined as

impl<IN, OUT> PartialEq for CallbackRef<IN, OUT>

fn eq(&self, other: &CallbackRef<IN, OUT>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.