MessageBuilder

Struct MessageBuilder 

pub struct MessageBuilder {
    topic: String,
    payload: Vec<u8>,
    qos: QoS,
    retained: bool,
    props: Properties,
}
Expand description

Builder to create a new Message

Fields§

§topic: String§payload: Vec<u8>§qos: QoS§retained: bool§props: Properties

Implementations§

§

impl MessageBuilder

pub fn new() -> MessageBuilder

Create a new message builder.

pub fn topic<T>(self, topic: T) -> MessageBuilder
where T: Into<String>,

Sets the topic for the message

§Arguments
  • topic The topic on which the message should be published.

pub fn payload<V>(self, payload: V) -> MessageBuilder
where V: Into<Vec<u8>>,

Sets the payload for the message

§Arguments
  • payload The binary payload of the message

pub fn qos<Q>(self, qos: Q) -> MessageBuilder
where Q: Into<QoS>,

Sets the Quality of Service for the message.

§Arguments
  • qos The quality of service for the message.

pub fn retained(self, retained: bool) -> MessageBuilder

Sets whether or not the published message should be retained by the broker.

§Arguments
  • retained Set true if the message should be retained by the broker, false if not.

pub fn properties(self, props: Properties) -> MessageBuilder

Sets the collection of properties for the message.

§Arguments
  • props The collection of properties to include with the message.

pub fn finalize(self) -> Message

Finalize the builder to create the message.

Trait Implementations§

§

impl Debug for MessageBuilder

§

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

Formats the value using the given formatter. Read more
§

impl Default for MessageBuilder

§

fn default() -> MessageBuilder

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

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

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

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

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.
§

impl<T> WithSubscriber for T

§

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
§

fn with_current_subscriber(self) -> WithDispatch<Self>

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