Struct Publish

Source
pub struct Publish<Bytes> { /* private fields */ }
Expand description

Implementations§

Source§

impl<Bytes> Publish<Bytes>
where Bytes: AnyVec<u8>,

Source

pub const TYPE: u8 = 3u8

The packet type constant

Source

pub fn new<T, P>( topic: T, payload: P, retain: bool, ) -> Result<Self, MemoryError>
where T: AsRef<[u8]>, P: AsRef<[u8]>,

Creates a new packet

Source

pub fn with_qos(self, qos: u8, packet_id: u16, dup: bool) -> Self

Configures the packet quality-of-service level and specifies whether this packet is a duplicate transmission (aka retry) or not

§QoS Levels

Valid QoS levels are:

  • 0: At most one delivery
  • 1: At least one delivery
  • 2: Exactly one delivery
Source

pub fn topic(&self) -> &[u8]

The message topic

Source

pub fn payload(&self) -> &[u8]

The payload

Source

pub fn retain(&self) -> bool

Whether the message should be retained

Source

pub fn dup(&self) -> bool

Whether this packet is a redelivery or not

Source

pub fn qos(&self) -> u8

The packet QoS

Source

pub fn packet_id(&self) -> Option<u16>

The packet ID

Trait Implementations§

Source§

impl<Bytes: Clone> Clone for Publish<Bytes>

Source§

fn clone(&self) -> Publish<Bytes>

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<Bytes: Debug> Debug for Publish<Bytes>

Source§

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

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

impl<Bytes> IntoIterator for Publish<Bytes>
where Bytes: AnyVec<u8>,

Source§

type Item = u8

The type of the elements being iterated over.
Source§

type IntoIter = Chain<Chain<Chain<Chain<Chain<Empty<u8>, Once<u8>>, Take<<[u8; 4] as IntoIterator>::IntoIter>>, Chain<<[u8; 2] as IntoIterator>::IntoIter, <Bytes as IntoIterator>::IntoIter>>, Take<<[u8; 2] as IntoIterator>::IntoIter>>, <Bytes as IntoIterator>::IntoIter>

Which kind of iterator are we turning this into?
Source§

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value. Read more
Source§

impl<Bytes: PartialEq> PartialEq for Publish<Bytes>

Source§

fn eq(&self, other: &Publish<Bytes>) -> bool

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl<Bytes> TryFromIterator for Publish<Bytes>
where Bytes: AnyVec<u8>,

Source§

fn try_from_iter<T>(iter: T) -> Result<Self, DecoderError>
where T: IntoIterator<Item = u8>,

Tries to build Self from the given byte iterator
Source§

impl<Bytes: Eq> Eq for Publish<Bytes>

Source§

impl<Bytes> StructuralPartialEq for Publish<Bytes>

Auto Trait Implementations§

§

impl<Bytes> Freeze for Publish<Bytes>
where Bytes: Freeze,

§

impl<Bytes> RefUnwindSafe for Publish<Bytes>
where Bytes: RefUnwindSafe,

§

impl<Bytes> Send for Publish<Bytes>
where Bytes: Send,

§

impl<Bytes> Sync for Publish<Bytes>
where Bytes: Sync,

§

impl<Bytes> Unpin for Publish<Bytes>
where Bytes: Unpin,

§

impl<Bytes> UnwindSafe for Publish<Bytes>
where Bytes: UnwindSafe,

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, 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.