Skip to main content

Eventual

Struct Eventual 

Source
pub struct Eventual<T> { /* private fields */ }
Available on crate feature std only.
Expand description

Represents a computation result that may eventually appear. Semantically equivalent to a Future, but doesn’t necessarily require an Async ecosystem around it.

Implementations§

Source§

impl<T> Eventual<T>

Source

pub fn new_loaded(val: T) -> Self

Creates a new already completed task with the specified value

Source

pub fn set(&self, val: Option<T>)

Sets the completion status of this task. Some becomes EventualStatus::Complete, None becomes EventualStatus::CompleteEmpty

Source

pub fn set_shared(&self, val: Arc<T>)

Sets the completed status to EventualStatus::Complete using the specified value.

Source

pub fn get(&self) -> EventualStatus<Arc<T>>

Gets the current status of this task. This is the primary method to poll over. See the module docs for an example.

Source

pub fn take(&self) -> Option<Arc<T>>

If the task is complete, take the Arc out of storage. Further calls to get or take will return None

Source

pub fn start(&self)

Move the task state from NotReady or CompleteEmpty to Running. Does nothing if already complete.

Source

pub fn is_ready(&self) -> bool

True if this task is complete with EventualStatus::CompleteEmpty or EventualStatus::Complete

Source

pub fn is_pending(&self) -> bool

True if this task has status [EventualStatus::NotRunning] or EventualStatus::Running

Source

pub fn block_until_ready(&self) -> EventualStatus<Arc<T>>

Blocks until this task transitions into EventualStatus::CompleteEmpty or EventualStatus::Complete. If already in this state, quick returns.

Trait Implementations§

Source§

impl<T: Clone> Clone for Eventual<T>

Source§

fn clone(&self) -> Eventual<T>

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> Default for Eventual<T>

Source§

fn default() -> Self

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

impl<T> Future for Eventual<T>

Source§

type Output = EventualStatus<Arc<T>>

The type of value produced on completion.
Source§

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Self::Output>

Attempts to resolve the future to a final value, registering the current task for wakeup if the value is not yet available. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Eventual<T>

§

impl<T> RefUnwindSafe for Eventual<T>

§

impl<T> Send for Eventual<T>
where T: Sync + Send,

§

impl<T> Sync for Eventual<T>
where T: Sync + Send,

§

impl<T> Unpin for Eventual<T>

§

impl<T> UnwindSafe for Eventual<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, 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<F> IntoFuture for F
where F: Future,

Source§

type Output = <F as Future>::Output

The output that the future will produce on completion.
Source§

type IntoFuture = F

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

fn into_future(self) -> <F as IntoFuture>::IntoFuture

Creates a future from a value. Read more
Source§

impl<T, U> MaybeInto<U> for T
where U: MaybeFrom<T>,

Source§

fn maybe_into(self) -> Option<U>

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.