Struct Properties

pub struct Properties {
    pub persistent: MissingOrNull<bool>,
    pub retained: MissingOrNull<bool>,
    pub cached: MissingOrNull<bool>,
}

Each published topic may also have properties associated to it. Properties are represented in the protocol as JSON and thus property values may be any JSON type. Property keys must be strings. The following properties have a defined meaning in this spec. Servers shall support arbitrary properties being set outside of this set. Clients shall ignore properties they do not recognize. Properties are initially set on publish and may be changed (by any client) using TextMessage::SetProperties

Fields

persistent: MissingOrNull<bool>

If true, the last set value will be periodically saved to persistent storage on the server and be restored during server startup. Topics with this property set to true will not be deleted by the server when the last publisher stops publishing.

retained: MissingOrNull<bool>

Topics with this property set to true will not be deleted by the server when the last publisher stops publishing.

cached: MissingOrNull<bool>

If false, the server and clients will not store the value of the topic. This means that only value updates will be available for the topic.

Implementations

impl Properties

pub fn update(&mut self, other: Properties)

Trait Implementations

impl Clone for Properties

fn clone(&self) -> Properties

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Properties

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

Formats the value using the given formatter.

impl Default for Properties

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Properties

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Properties

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Properties