Struct poster::PublishOpts

pub struct PublishOpts<'a> { /* private fields */ }

Publish options, represented as a consuming builder. Used during publish request, translated to the PUBLISH packet.

Implementations

impl<'a> PublishOpts<'a>

pub fn new() -> Self

Creates a new PublishOpts instance.

pub fn retain(self, val: bool) -> Self

Sets a retain flag.

pub fn qos(self, val: QoS) -> Self

Sets QoS level.

pub fn topic(self, val: &'a str) -> Self

Sets topic.

pub fn payload_format_indicator(self, val: bool) -> Self

Sets payload format indicator. Value false indicates that the will payload is in unspecified format. Value true indicates that the payload is UTF8 encoded character data.

pub fn topic_alias(self, val: u16) -> Self

Sets the topic alias.

Arguments

val - value greater than 0

Panics

When val equals 0.

pub fn message_expiry_interval(self, val: Duration) -> Self

Sets the expiry interval of the message.

Arguments

val - Duration value less than u32::MAX in seconds.

Panics

When the duration in seconds is greater than u32::MAX.

pub fn correlation_data(self, val: &'a [u8]) -> Self

Sets correlation data.

pub fn response_topic(self, val: &'a str) -> Self

Sets response topic.

pub fn content_type(self, val: &'a str) -> Self

Sets message content type.

pub fn user_property(self, (key, val): (&'a str, &'a str)) -> Self

Sets user properties as key-value pairs. Multiple user properties may be set.

pub fn data(self, val: &'a [u8]) -> Self

Sets message data.

Trait Implementations

impl<'a> Default for PublishOpts<'a>

fn default() -> PublishOpts<'a>

Returns the “default value” for a type.