Struct ockam_node::Cancel[−][src]

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

Expand description

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

[src]

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

[src]

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

Cancel this message

[src]

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

[src]

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

[src]

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

Formats the value using the given formatter. Read more

[src]

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

type Target = M

The resulting type after dereferencing.

[src]

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

Dereferences the value.

[src]

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

[src]

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

Formats the value using the given formatter. Read more

[src]

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

[src]

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

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

1.0.0[src]

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

This method tests for !=.

Auto Trait Implementations

impl<'ctx, M> !RefUnwindSafe for Cancel<'ctx, M>

impl<'ctx, M> Send for Cancel<'ctx, M>

impl<'ctx, M> Sync for Cancel<'ctx, M> where
M: Sync,

impl<'ctx, M> Unpin for Cancel<'ctx, M> where
M: Unpin,

impl<'ctx, M> !UnwindSafe for Cancel<'ctx, M>

Blanket Implementations

[src]

impl<T> Any for T where
T: 'static + ?Sized,

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

impl<T> Borrow<T> for T where
T: ?Sized,

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

impl<T> BorrowMut<T> for T where
T: ?Sized,

[src]

pub fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

impl<T> Instrument for T

[src]

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

[src]

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

[src]

impl<T, U> Into for T where
U: From<T>,

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

impl<T> ToString for T where
T: Display + ?Sized,

[src]

pub default fn to_string(&self) -> String

Converts the given value to a String. Read more

[src]

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

[src]

pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

[src]

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

pub fn vzip(self) -> V

[src]

impl<T> WithSubscriber for T

[src]

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

[src]

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

Struct ockam_node::Cancel[−][src]

Implementations

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

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

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

Trait Implementations

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

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

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

type Target = M

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

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

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

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

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

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

Auto Trait Implementations

impl<'ctx, M> !RefUnwindSafe for Cancel<'ctx, M>

impl<'ctx, M> Send for Cancel<'ctx, M>

impl<'ctx, M> Sync for Cancel<'ctx, M> where M: Sync,

impl<'ctx, M> Unpin for Cancel<'ctx, M> where M: Unpin,

impl<'ctx, M> !UnwindSafe for Cancel<'ctx, M>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

pub fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

pub fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

pub fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

pub fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for T where U: From<T>,

pub fn into(self) -> U

impl<T> ToString for T where T: Display + ?Sized,

pub default fn to_string(&self) -> String

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for T where V: MultiLane<T>,

pub fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where S: Into<Dispatch>,

fn with_current_subscriber(self) -> WithDispatch<Self>

impl<'ctx, M> Sync for Cancel<'ctx, M> where
M: Sync,

impl<'ctx, M> Unpin for Cancel<'ctx, M> where
M: Unpin,

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

impl<T> ToString for T where
T: Display + ?Sized,

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,