Struct ichen_openprotocol::MessageOptions

pub struct MessageOptions<'a> {
    pub id: Option<&'a str>,
    pub sequence: u64,
    pub priority: i32,
}

Common options of an Open Protocol message.

Fields

id: Option<&'a str>

Unique ID (if any) of the message for tracking and storage retrieval purposes.

The iChen Server may tag certain messages with a unique tracking key that can be used to retrieve the message from persistent storage later.

sequence: u64

Ever-increasing message sequence number.

This number is usually auto-incremented with each message created, starting from 1.

priority: i32

Priority of the message, smaller number is higher priority. Default = 0.

Methods

impl<'a> MessageOptions<'a>

pub fn new() -> Self

Create a MessageOptions with default values (for example, the sequence field auto-increments).

Examples

let opt1 = MessageOptions::new();
assert_eq!(1, opt1.sequence);
assert_eq!(0, opt1.priority);

let opt2 = MessageOptions::new();
assert_eq!(2, opt2.sequence);       // `sequence` auto-increments.
assert_eq!(0, opt2.priority);

pub fn new_with_priority(priority: i32) -> Self

Create a MessageOptions with a particular priority but otherwise default values (for example, the sequence field auto-increments).

Examples

let opt1 = MessageOptions::new_with_priority(100);
assert_eq!(1, opt1.sequence);
assert_eq!(100, opt1.priority);

let opt2 = MessageOptions::new_with_priority(-42);
assert_eq!(2, opt2.sequence);       // `sequence` auto-increments.
assert_eq!(-42, opt2.priority);

pub fn validate(&self) -> Result<'static, ()>

Validate the data structure.

Errors

Returns Err(OpenProtocolError::EmptyField) if the id field is set to an empty string or is all whitespace.

Examples

let opt1 = MessageOptions { id: Some(""), ..Default::default() };
assert_eq!(r#"Err(EmptyField("id"))"#, format!("{:?}", opt1.validate()));

Trait Implementations

impl<'a> Clone for MessageOptions<'a>

fn clone(&self) -> MessageOptions<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'_> Default for MessageOptions<'_>

fn default() -> Self

Default value for MessageOptions.

The sequence field is auto-incrementing.

Examples

let opt1: MessageOptions = Default::default();
assert_eq!(1, opt1.sequence);
assert_eq!(0, opt1.priority);

let opt2: MessageOptions = Default::default();
assert_eq!(2, opt2.sequence);       // `sequence` auto-increments.
assert_eq!(0, opt2.priority);

impl<'a> PartialEq<MessageOptions<'a>> for MessageOptions<'a>

fn eq(&self, other: &MessageOptions<'a>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &MessageOptions<'a>) -> bool

This method tests for !=.

impl<'a> Debug for MessageOptions<'a>

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

Formats the value using the given formatter.

impl<'a> Serialize for MessageOptions<'a>

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

Serialize this value into the given Serde serializer.

impl<'de: 'a, 'a> Deserialize<'de> for MessageOptions<'a>

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.