Struct swctx::WaitCtx

pub struct WaitCtx<T, S, E>(/* private fields */);

End-point used to wait for a value to be sent from the paired SetCtx.

Implementations

impl<T, S, E> WaitCtx<T, S, E>

pub fn wait(self) -> Result<T, Error<S, E>>

Wait for the paired SetCtx to set a value or fail.

Errors

Returns application-specific error wrapped in an Error::App if the SetCtx reported failure.

pub fn try_get(&self) -> Result<Option<T>, Error<S, E>>

Non-blocking attempt to get the get the stored value.

Returns Ok(Some(T)) if a value has been stored. Returns Ok(None) if no value has been stored.

Errors

Returns application-specific error wrapped in an Error::App if the SetCtx reported failure.

Panics

This function will panic if called again after it has resolved to either data or error.

pub const fn wait_async(&self) -> WaitFuture<'_, T, S, E>

Return a Future that will wait for either data to be set or an error to occur.

Cancel safety

The returned Future is cancel safe.

Panics

This function will panic if called again after it has resolved to either data or error.

Trait Implementations

impl<T, S, E> Drop for WaitCtx<T, S, E>

fn drop(&mut self)

Executes the destructor for this type.

impl<T, S, E> Future for WaitCtx<T, S, E>

type Output = Result<T, Error<S, E>>

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, ctx: &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.