Skip to main content

Inbox

Struct Inbox 

Source
pub struct Inbox(/* private fields */);
Expand description

The messages arriving on a transport’s connection, readable apart from the transport.

recv borrows the transport for as long as it waits, so a program that waits for commands in one task while it publishes readings from another takes an inbox with MqttTransport::inbox and waits on that instead. The inbox follows the transport across reconnects.

Implementations§

Source§

impl Inbox

Source

pub async fn recv(&self) -> Result<Option<Message>>

Awaits the next message from any subscribed topic.

§Returns

Some(message) for the next queued message, or None once the connection has ended and its reason has been reported.

§Errors

Returns Error::Closed if the transport is not connected, or Error::Transport once, saying why, when the connection ended on its own.

Trait Implementations§

Source§

impl Clone for Inbox

Source§

fn clone(&self) -> Inbox

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Inbox

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Inbox

Source§

fn default() -> Inbox

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Inbox

§

impl !UnwindSafe for Inbox

§

impl Freeze for Inbox

§

impl Send for Inbox

§

impl Sync for Inbox

§

impl Unpin for Inbox

§

impl UnsafeUnpin for Inbox

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.