FutureSignal

Struct FutureSignal 

Source
pub struct FutureSignal<T> { /* private fields */ }
Expand description

A reactive signal for futures that resolve to a single value.

FutureSignal provides a way to reactively consume values from async futures and automatically update UI when the future completes. It manages the future lifecycle and provides access to both the current value and completion state.

The value is always Option<T> where None means the future hasn’t completed yet and Some(T) means the future has completed with the result.

§Examples

// Simple case: event loop executor
let future_signal = FutureSignal::new(my_future);

// Full customization
let future_signal = FutureSignal::custom(my_future)
    .tokio_spawn()
    .build();

Implementations§

Source§

impl<T: 'static> FutureSignal<T>

Source

pub fn new<Fut>(future: Fut) -> Self
where Fut: Future<Output = T> + 'static, T: 'static,

Creates a new reactive future signal with sensible defaults.

  • Executor: Main event loop (future does not need to be Send)
  • Initial value: Always None until the future completes
§Parameters
  • future - The async future to consume.
§Examples
let future_signal = FutureSignal::new(my_future);
Source

pub fn custom<Fut>( future: Fut, ) -> FutureSignalBuilder<Fut, T, EventLoopExecutor>
where Fut: Future<Output = T> + 'static, T: 'static,

Creates a future signal builder for full customization.

Use this when you need to customize:

  • The executor (tokio, custom, etc.)
§Examples
// Tokio executor
let future_signal = FutureSignal::custom(my_future)
    .tokio_spawn()
    .build();
Source

pub fn is_finished(&self) -> bool

Trait Implementations§

Source§

impl<T> Clone for FutureSignal<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<T: Clone> SignalGet<Option<T>> for FutureSignal<T>

Source§

fn id(&self) -> ReactiveId

get the Signal Id
Source§

fn get_untracked(&self) -> T
where T: 'static,

Source§

fn get(&self) -> T
where T: 'static,

Source§

fn try_get(&self) -> Option<T>
where T: 'static,

Source§

fn try_get_untracked(&self) -> Option<T>
where T: 'static,

Source§

impl<T> SignalRead<Option<T>> for FutureSignal<T>

Source§

fn id(&self) -> ReactiveId

get the Signal Id
Source§

fn try_read(&self) -> Option<ReadRef<'_, Option<T>>>
where T: 'static,

If the signal isn’t disposed, reads the data stored in the Signal and subscribes to the current running effect.
Source§

fn try_read_untracked(&self) -> Option<ReadRef<'_, Option<T>>>
where T: 'static,

If the signal isn’t disposed, reads the data stored in the Signal without subscribing.
Source§

fn read(&self) -> ReadRef<'_, T>
where T: 'static,

Reads the data stored in the Signal, subscribing the current running effect.
Source§

fn read_untracked(&self) -> ReadRef<'_, T>
where T: 'static,

Reads the data stored in the Signal without subscribing.
Source§

impl<T> SignalTrack<Option<T>> for FutureSignal<T>

Source§

fn id(&self) -> ReactiveId

Source§

fn track(&self)

Only subscribes to the current running effect to this Signal.
Source§

fn try_track(&self)

If the signal isn’t disposed,
Source§

impl<T> SignalWith<Option<T>> for FutureSignal<T>

Source§

fn id(&self) -> ReactiveId

get the Signal Id
Source§

fn with<O>(&self, f: impl FnOnce(&T) -> O) -> O
where T: 'static,

Source§

fn with_untracked<O>(&self, f: impl FnOnce(&T) -> O) -> O
where T: 'static,

Source§

fn try_with<O>(&self, f: impl FnOnce(Option<&T>) -> O) -> O
where T: 'static,

Source§

fn try_with_untracked<O>(&self, f: impl FnOnce(Option<&T>) -> O) -> O
where T: 'static,

Source§

impl<T> Copy for FutureSignal<T>

Auto Trait Implementations§

§

impl<T> Freeze for FutureSignal<T>

§

impl<T> RefUnwindSafe for FutureSignal<T>
where T: RefUnwindSafe,

§

impl<T> !Send for FutureSignal<T>

§

impl<T> !Sync for FutureSignal<T>

§

impl<T> Unpin for FutureSignal<T>
where T: Unpin,

§

impl<T> UnwindSafe for FutureSignal<T>
where T: UnwindSafe,

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> 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<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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> AutoreleaseSafe for T
where T: ?Sized,

Source§

impl<T> AutoreleaseSafe for T
where T: ?Sized,