Skip to main content

CljxFuture

Struct CljxFuture 

Source
pub struct CljxFuture {
    pub state: Mutex<FutureState>,
    pub cond: Condvar,
    /* private fields */
}
Expand description

A future value computed asynchronously on another thread.

Fields§

§state: Mutex<FutureState>§cond: Condvar

Implementations§

Source§

impl CljxFuture

Source

pub fn new() -> Self

Source

pub fn is_done(&self) -> bool

True if done, failed, or cancelled (not still running).

Source

pub fn is_cancelled(&self) -> bool

True if explicitly cancelled.

Source

pub fn cancel(&self) -> bool

Mark a still-running future cancelled, waking anyone waiting on it.

Returns false when it had already settled. The task itself is not interrupted; what is cancelled is the result.

Source

pub fn cancelled_error() -> Value

The catchable value every reader of a cancelled future raises.

One shape for every path — the sync tree-walker’s await/deref, the async tree-walker, and the compiled state machine all hand user code the same ex-info-like error, so a catch behaves the same whether or not the enclosing fn happened to be async-JIT-compiled.

Source

pub fn mark_observed(&self)

Mark this future’s result as observed. Call when a consumer reads the settled value (await/deref), so a later drop doesn’t warn about an unobserved error.

Trait Implementations§

Source§

impl Debug for CljxFuture

Source§

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

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

impl Default for CljxFuture

Source§

fn default() -> Self

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

impl Drop for CljxFuture

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)
Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned. Read more
Source§

impl Trace for CljxFuture

Source§

fn trace(&self, visitor: &mut MarkVisitor)

Source§

fn gc_size_extra(&self) -> usize

Auto Trait Implementations§

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

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