Struct dioxus_hooks::UseFuture

source ·
pub struct UseFuture<T> { /* private fields */ }

Implementations§

source§

impl<T> UseFuture<T>

source

pub fn restart(&self)

Restart the future with new dependencies.

Will not cancel the previous future, but will ignore any values that it generates.

source

pub fn cancel(&self, cx: &ScopeState)

Forcefully cancel a future

source

pub fn clear(&self) -> Option<T>

source

pub fn set(&self, _new_value: T)

source

pub fn value(&self) -> Option<&T>

Return any value, even old values if the future has not yet resolved.

If the future has never completed, the returned value will be None.

source

pub fn task(&self) -> Option<TaskId>

Get the ID of the future in Dioxus’ internal scheduler

source

pub fn state(&self) -> UseFutureState<'_, T>

Get the current state of the future.

Trait Implementations§

source§

impl<'a, T> IntoFuture for &'a UseFuture<T>

§

type Output = &'a T

The output that the future will produce on completion.
§

type IntoFuture = UseFutureAwait<'a, T>

Which kind of future are we turning this into?
source§

fn into_future(self) -> Self::IntoFuture

Creates a future from a value. Read more

Auto Trait Implementations§

§

impl<T> !RefUnwindSafe for UseFuture<T>

§

impl<T> !Send for UseFuture<T>

§

impl<T> !Sync for UseFuture<T>

§

impl<T> Unpin for UseFuture<T>

§

impl<T> !UnwindSafe for UseFuture<T>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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.

source§

impl<T, U> Into<U> for Twhere 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, U> TryFrom<U> for Twhere 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 Twhere 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.