Struct PublishOptions 

pub struct PublishOptions { /* private fields */ }

How one message is published: its quality of service, and whether the broker keeps it.

A retained message is the one the broker hands to every client that subscribes to the topic later, so a new dashboard sees the last reading at once rather than waiting for the next (OASIS MQTT 3.1.1, section 3.3.1.3). Publishing an empty retained message clears the one the broker holds.

Implementations

impl PublishOptions

pub fn new() -> PublishOptions

Options that publish at the connection’s quality of service, not retained.

Returns

The options.

pub fn qos(self, qos: QualityOfService) -> PublishOptions

Publishes at a quality of service other than the connection’s.

Arguments

• qos - the delivery guarantee for this message.

Returns

The updated options, for chaining.

pub fn retained(self) -> PublishOptions

Has the broker retain the message for clients that subscribe later.

Returns

The updated options, for chaining.

pub fn is_retained(&self) -> bool

Returns whether the message is retained.

Returns

true for a retained message.

Trait Implementations

impl Clone for PublishOptions

fn clone(&self) -> PublishOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PublishOptions

impl Debug for PublishOptions

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

Formats the value using the given formatter.

impl Default for PublishOptions

fn default() -> PublishOptions

Returns the “default value” for a type.

impl Eq for PublishOptions

impl PartialEq for PublishOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PublishOptions