Struct ockam_node::Cancel

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

A message wrapper 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: Message> Cancel<'ctx, M>

pub async fn cancel(self) -> Result<()>

Cancel this message

This results in the message being re-queued at the back of the worker’s mailbox so that it can be handled by a future handle_message call

use ockam_node::Context;
use ockam_core::Result;
let msg = ctx.receive::<String>().await?;
if &*msg != "hello ockam" {
    msg.cancel().await?;
}

pub fn take(self) -> Routed<M>

Consume the Cancel wrapper to take the underlying message

After calling this function it is no longer possible to re-queue the message into the worker mailbox.

Trait Implementations

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

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

Formats the value using the given formatter.

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

type Target = M

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

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

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

Formats the value using the given formatter.

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

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

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.