Skip to main content

Action

Struct Action 

Source
pub struct Action<I, T: 'static> { /* private fields */ }
Expand description

A handle to an async action created by use_action.

Call it with .call(...) to dispatch work, read results with .value(), and check progress with .pending(). Implements Copy so it can be moved into multiple event handlers freely.

Implementations§

Source§

impl<I: 'static, O: 'static> Action<I, O>

Source

pub fn value(&self) -> Option<Result<ReadSignal<O>, CapturedError>>

The result of the most recent call, if it has completed.

Returns None while the action is pending or has never been called. Returns Some(Ok(signal)) on success or Some(Err(e)) on failure. The returned ReadSignal is reactive — reading it in RSX will subscribe the component to updates.

Source

pub fn pending(&self) -> bool

Returns true while a call is in flight.

Source

pub fn reset(&mut self)

Clear the result and cancel any in-flight work.

Source

pub fn cancel(&mut self)

Cancel the in-flight task without clearing the previous result’s state.

Source§

impl<Out> Action<(), Out>

Source

pub fn call(&mut self) -> Dispatching<()>

Dispatch the action with no arguments.

Source§

impl<A: 'static, Out> Action<(A,), Out>

Source

pub fn call(&mut self, A: A) -> Dispatching<()>

Dispatch the action with the given arguments.

Source§

impl<A: 'static, B: 'static, Out> Action<(A, B), Out>

Source

pub fn call(&mut self, A: A, B: B) -> Dispatching<()>

Dispatch the action with the given arguments.

Source§

impl<A: 'static, B: 'static, C: 'static, Out> Action<(A, B, C), Out>

Source

pub fn call(&mut self, A: A, B: B, C: C) -> Dispatching<()>

Dispatch the action with the given arguments.

Source§

impl<A: 'static, B: 'static, C: 'static, D: 'static, Out> Action<(A, B, C, D), Out>

Source

pub fn call(&mut self, A: A, B: B, C: C, D: D) -> Dispatching<()>

Dispatch the action with the given arguments.

Source§

impl<A: 'static, B: 'static, C: 'static, D: 'static, E: 'static, Out> Action<(A, B, C, D, E), Out>

Source

pub fn call(&mut self, A: A, B: B, C: C, D: D, E: E) -> Dispatching<()>

Dispatch the action with the given arguments.

Source§

impl<A: 'static, B: 'static, C: 'static, D: 'static, E: 'static, F: 'static, Out> Action<(A, B, C, D, E, F), Out>

Source

pub fn call(&mut self, A: A, B: B, C: C, D: D, E: E, F: F) -> Dispatching<()>

Dispatch the action with the given arguments.

Trait Implementations§

Source§

impl<I, T> Clone for Action<I, T>

Source§

fn clone(&self) -> Self

Returns a duplicate 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<I, T> Debug for Action<I, T>
where T: Debug + 'static,

Source§

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

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

impl<I, T> PartialEq for Action<I, T>

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl<I, T> Copy for Action<I, T>

Auto Trait Implementations§

§

impl<I, T> Freeze for Action<I, T>

§

impl<I, T> !RefUnwindSafe for Action<I, T>

§

impl<I, T> !Send for Action<I, T>

§

impl<I, T> !Sync for Action<I, T>

§

impl<I, T> Unpin for Action<I, T>
where T: Unpin,

§

impl<I, T> UnsafeUnpin for Action<I, T>

§

impl<I, T> !UnwindSafe for Action<I, T>

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> InitializeFromFunction<T> for T

Source§

fn initialize_from_function(f: fn() -> T) -> T

Create an instance of this type from an initialization function
Source§

impl<T> Instrument for T

Source§

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

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

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<Ret> SpawnIfAsync<(), Ret> for Ret

Source§

fn spawn(self) -> Ret

Spawn the value into the dioxus runtime if it is an async block
Source§

impl<T, O> SuperFrom<T> for O
where O: From<T>,

Source§

fn super_from(input: T) -> O

Convert from a type to another type.
Source§

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

Source§

fn super_into(self) -> O

Convert from a type to another type.
Source§

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

Source§

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

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.
Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> DependencyElement for T
where T: 'static + PartialEq + Clone,