Skip to main content

Message

Struct Message 

pub struct Message {
    pub topic: String,
    pub payload: Vec<u8>,
}
Expand description

A message that arrived on a subscribed topic.

Every link that can deliver hands back the same shape, so a node reads a command the same way whether it came over MQTT, CoAP, Zenoh, or the in-process broker used in tests.

Fields§

§topic: String

The topic the message was published to.

§payload: Vec<u8>

The raw payload bytes.

Implementations§

§

impl Message

pub fn new(topic: impl Into<String>, payload: impl Into<Vec<u8>>) -> Message

Creates a message from a topic and a payload.

§Arguments
  • topic - the topic the message was published to.
  • payload - the raw payload bytes.
§Returns

The message.

pub fn text(&self) -> Result<&str, Error>

Reads the payload as text.

Most readings and commands on a topic are words or a number written out, and this is the accessor for them; a payload that is a codec’s bytes goes through the codec instead.

§Returns

The payload as a string slice.

§Errors

Returns Error::Codec if the payload is not UTF-8 text.

pub fn number(&self) -> Result<f64, Error>

Reads the payload as a number written out as text, such as 21.5.

§Returns

The number.

§Errors

Returns Error::Codec if the payload is not UTF-8 text or the text is not a number.

Trait Implementations§

§

impl Clone for Message

§

fn clone(&self) -> Message

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
§

impl Debug for Message

§

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

Formats the value using the given formatter. Read more
§

impl Eq for Message

§

impl PartialEq for Message

§

fn eq(&self, other: &Message) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
§

impl StructuralPartialEq for Message

Auto Trait Implementations§

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.