Struct SubscriptionOptions

pub struct SubscriptionOptions {
    pub periodic: Option<u32>,
    pub all: Option<bool>,
    pub topicsonly: Option<bool>,
    pub prefix: Option<bool>,
}

Each subscription may have options set. The following options have a defined meaning in this spec. Servers shall preserve arbitrary options, as servers and clients may support arbitrary options outside of this set. Options are set using Subscribe Message (TextMessage::Subscribe) and cannot be changed.

Fields

periodic: Option<u32>

How frequently the server should send changes. The server may send more frequently than this (e.g. use a combined minimum period for all values) or apply a restricted range to this value. The default if unspecified is 100 ms (same as NT 3.0).

all: Option<bool>

If true, the server should send all value changes over the wire. If false, only the most recent value is sent (same as NT 3.0 behavior). If not specified, defaults to false.

topicsonly: Option<bool>

If true, the server should not send any value changes over the wire regardless of other options. This is useful for only getting topic announcements. If false, value changes are sent in accordance with other options. If not specified, defaults to false.

prefix: Option<bool>

If true, any topic starting with the name in the subscription topics list is subscribed to, not just exact matches. If not specified, defaults to false.

Trait Implementations

impl Debug for SubscriptionOptions

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

Formats the value using the given formatter.

impl Default for SubscriptionOptions

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubscriptionOptions

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for SubscriptionOptions

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.