Struct ockam::Cancel

pub struct Cancel<'ctx, M> where
    M: Message,  { /* fields omitted */ }

A message wraper type that allows users to cancel message receival

A worker can block in place to wait for a message. If the next message is not the desired type, it can be cancelled which re-queues it into the mailbox.

Implementations

impl<'ctx, M> Cancel<'ctx, M> where
    M: Message, 

pub async fn cancel(self)

Cancel this message

Trait Implementations

impl<'ctx, M> Debug for Cancel<'ctx, M> where
    M: Debug + Message, 

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

Formats the value using the given formatter.

impl<'ctx, M> Deref for Cancel<'ctx, M> where
    M: Message, 

type Target = M

The resulting type after dereferencing.

pub fn deref(&self) -> &<Cancel<'ctx, M> as Deref>::Target

Dereferences the value.

impl<'ctx, M> Display for Cancel<'ctx, M> where
    M: Display + Message, 

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

Formats the value using the given formatter.

impl<'ctx, M> PartialEq<M> for Cancel<'ctx, M> where
    M: PartialEq<M> + Message, 

pub fn eq(&self, o: &M) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]pub fn ne(&self, other: &Rhs) -> bool

This method tests for !=.