Struct dioxus_hooks::UseFuture

pub struct UseFuture { /* private fields */ }

Implementations

impl UseFuture

pub fn restart(&mut self)

Restart the future with new dependencies.

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

pub fn cancel(&mut self)

Forcefully cancel a future

pub fn pause(&mut self)

Pause the future

pub fn resume(&mut self)

Resume the future

pub fn task(&self) -> Task

Get a handle to the inner task backing this future Modify the task through this handle will cause inconsistent state

pub fn finished(&self) -> bool

Is the future currently finished running?

Reading this does not subscribe to the future’s state

pub fn state(&self) -> ReadOnlySignal<UseFutureState>

Get the current state of the future.

Trait Implementations

impl Clone for UseFuture

fn clone(&self) -> UseFuture

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Deref for UseFuture

Allow calling a signal with signal() syntax

Currently only limited to copy types, though could probably specialize for string/arc/rc

type Target = dyn Fn() -> UseFutureState

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl From<UseFuture> for ReadOnlySignal<UseFutureState>

fn from(val: UseFuture) -> Self

Converts to this type from the input type.

impl Readable for UseFuture

type Target = UseFutureState

The target type of the reference.

type Storage = UnsyncStorage

The type of the storage this readable uses.

fn try_read_unchecked(&self) -> Result<ReadableRef<'static, Self>, BorrowError>

Try to get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal.

fn peek_unchecked(&self) -> ReadableRef<'static, Self>

Get the current value of the signal without checking the lifetime. Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update.

fn map<O>( self, f: impl Fn(&Self::Target) -> &O + 'static ) -> MappedSignal<O, Self::Storage>

where Self: Sized + Clone + 'static,

Map the readable type to a new type.

fn read(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>

Get the current value of the state. If this is a signal, this will subscribe the current scope to the signal. If the value has been dropped, this will panic. Calling this on a Signal is the same as using the signal() syntax to read and subscribe to its value

fn try_read( &self ) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>

Try to get the current value of the state. If this is a signal, this will subscribe the current scope to the signal.

fn read_unchecked( &self ) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>

Get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal.

fn peek(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>

Get the current value of the state without subscribing to updates. If the value has been dropped, this will panic.

fn cloned(&self) -> Self::Target

where Self::Target: Clone,

Clone the inner value and return it. If the value has been dropped, this will panic.

fn with<O>(&self, f: impl FnOnce(&Self::Target) -> O) -> O

Run a function with a reference to the value. If the value has been dropped, this will panic.

fn with_peek<O>(&self, f: impl FnOnce(&Self::Target) -> O) -> O

Run a function with a reference to the value. If the value has been dropped, this will panic.

fn index<I>( &self, index: I ) -> <Self::Storage as AnyStorage>::Ref<'_, <Self::Target as Index<I>>::Output>

where Self::Target: Index<I>,

Index into the inner value and return a reference to the result. If the value has been dropped or the index is invalid, this will panic.

impl Copy for UseFuture