This is unreleased documentation for Yew Next version.
For up-to-date documentation, see the latest version on docs.rs.

Struct yew::callback::Callback

source ·
pub struct Callback<IN, OUT = ()> { /* private fields */ }
Expand description

Universal callback wrapper.

An Rc wrapper is used to make it cloneable.

Implementations§

source§

impl<IN, OUT> Callback<IN, OUT>

source

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

This method calls the callback’s function.

source§

impl<IN> Callback<IN>

source

pub fn noop() -> Self

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

source§

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

source

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

source

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

source

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

source

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.

source

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.

source

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§

source§

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

source§

fn clone(&self) -> Self

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Formats the value using the given formatter. Read more
source§

impl<IN> Default for Callback<IN>

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

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

source§

fn from(func: F) -> Self

Converts to this type from the input type.
source§

impl<T> From<UseReducerDispatcher<T>> for Callback<<T as Reducible>::Action>
where T: Reducible,

source§

fn from(val: UseReducerDispatcher<T>) -> Self

Converts to this type from the input type.
source§

impl<T> From<UseStateSetter<T>> for Callback<T>

source§

fn from(value: UseStateSetter<T>) -> Self

Converts to this type from the input type.
source§

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

§

fn implicit_clone(&self) -> Self

This function is not magic; it is literally defined as Read more
source§

impl<EVENT> IntoEventCallback<EVENT> for &Callback<EVENT>

source§

fn into_event_callback(self) -> Option<Callback<EVENT>>

Convert self to Option<Callback<EVENT>>
source§

impl<EVENT> IntoEventCallback<EVENT> for Callback<EVENT>

source§

fn into_event_callback(self) -> Option<Callback<EVENT>>

Convert self to Option<Callback<EVENT>>
source§

impl<T> IntoPropValue<Callback<<T as Reducible>::Action>> for UseReducerDispatcher<T>
where T: Reducible,

source§

fn into_prop_value(self) -> Callback<<T as Reducible>::Action>

Convert self to a value of a Properties struct.
source§

impl<I, O, F> IntoPropValue<Callback<I, O>> for F
where F: 'static + Fn(I) -> O,

source§

fn into_prop_value(self) -> Callback<I, O>

Convert self to a value of a Properties struct.
source§

impl<T> IntoPropValue<Callback<T>> for UseStateSetter<T>

source§

fn into_prop_value(self) -> Callback<T>

Convert self to a value of a Properties struct.
source§

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

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

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

Auto Trait Implementations§

§

impl<IN, OUT> Freeze for Callback<IN, OUT>

§

impl<IN, OUT = ()> !RefUnwindSafe for Callback<IN, OUT>

§

impl<IN, OUT = ()> !Send for Callback<IN, OUT>

§

impl<IN, OUT = ()> !Sync for Callback<IN, OUT>

§

impl<IN, OUT> Unpin for Callback<IN, OUT>

§

impl<IN, OUT = ()> !UnwindSafe for Callback<IN, OUT>

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
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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> IntoPropValue<Option<T>> for T

source§

fn into_prop_value(self) -> Option<T>

Convert self to a value of a Properties struct.
source§

impl<T> IntoPropValue<T> for T

source§

fn into_prop_value(self) -> T

Convert self to a value of a Properties struct.
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

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

§

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>,

§

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