Struct pinky_swear::PinkySwear

#[must_use = "PinkySwear should be used or you can miss errors"]pub struct PinkySwear<T, S = T> { /* fields omitted */ }

A PinkySwear is a Promise that the other party is supposed to honour at some point.

Methods

impl<T: Send + 'static, S: Send + 'static> PinkySwear<T, S>

pub fn new() -> (Self, Pinky<T>)

Create a new PinkySwear and its associated Pinky.

pub fn new_with_data(data: T) -> Self

Create a new PinkySwear and honour it at the same time.

pub fn try_wait(&self) -> Option<T>

Check whether the Promise has been honoured or not.

pub fn wait(&self) -> T

Wait until the Promise has been honoured.

pub fn subscribe<N: NotifyReady + Send + 'static>(&self, task: N)

Get notified once the Promise has been honoured.

pub fn has_subscriber(&self) -> bool

Will someone get notified once the Promise is honoured?

pub fn drop_subscribers(&self)

Drop all the pending subscribers

pub fn traverse<F: Send + 'static, TF: Fn(T) -> F + Send + 'static>(
    self,
    transform: TF
) -> PinkySwear<F, T>

Apply a tranformation to the result of a PinkySwear.

pub fn set_marker(&self, marker: String)

Add a marker to logs

impl<T: Send + 'static> PinkySwear<T, ()>

pub fn after<B: Send + 'static>(promise: PinkySwear<(), B>) -> (Self, Pinky<T>)

Wait for this promise only once the given one is honoured.

impl<T: Send + 'static, E: Send + 'static> PinkySwear<Result<T, E>, Result<(), E>>

pub fn after<B: Send + 'static>(
    promise: PinkySwear<Result<(), E>, B>
) -> (Self, Pinky<Result<T, E>>)

Wait for this promise only once the given one is honoured.

Trait Implementations

impl<T, S> Debug for PinkySwear<T, S>

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

Formats the value using the given formatter.

impl<T, S> Drop for PinkySwear<T, S>

fn drop(&mut self)

Executes the destructor for this type.

impl<T: Send + 'static, S: Send + 'static> Future for PinkySwear<T, S>

type Output = T

The type of value produced on completion.

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

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