Struct SubscriptionOptions 

pub struct SubscriptionOptions {
    pub retain_handling: RetainHandling,
    pub retain_as_published: bool,
    pub no_local: bool,
    pub qos: QoS,
    pub subscription_identifier: Option<VarByteInt>,
}

Options for subscription included for every topic.

Fields

retain_handling: RetainHandling

Serverside retain handling configuration for this subscription.

retain_as_published: bool

If set to true, the server sets the retain flag of a PUBLISH packet matching this subscription to the retain flag value of the original publication. If set to false, the server sets the retain flag of a PUBLISH packet matching this subscription to false. This does not apply for retained messages sent directly after subscribing - these messages always have the retain flag set to 1.

no_local: bool

If set to true, the server does not forward any publications matching this subscription to connections with client identifiers the same as the client identifier of this connection. If set to true on a shared subscription, a protocol error is triggered.

qos: QoS

The maximum quality of service that the server can forward publications matching this subscription with to the client. A quality of service level lower than this can be granted by the server.

subscription_identifier: Option<VarByteInt>

The subscription identifier of the subscription. The server will set subscription identifier properties in its PUBLISH packets to the values of all matching subscriptions with a subscription identifier.

Implementations

impl Options

pub const fn new() -> Self

Creates options with values coherent to the Default implementations of the fields and QoS::AtMostOnce.

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

Sets the Quality of Service level.

pub const fn at_least_once(self) -> Self

Sets the Quality of Service level to 1 (At Least Once).

pub const fn exactly_once(self) -> Self

Sets the Quality of Service level to 1 (Exactly Once).

pub const fn retain_handling(self, retain_handling: RetainHandling) -> Self

Sets the serverside retain handling configuration for this subscription.

pub const fn retain_as_published(self) -> Self

Sets the retain as published flag to true.

pub const fn no_local(self) -> Self

Sets the no local flag to true.

pub const fn subscription_identifier( self, subscription_identifier: VarByteInt, ) -> Self

Sets the subscription identifier property.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Options

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.

impl Copy for Options