Struct ichen_openprotocol::MessageOptions

pub struct MessageOptions<'a> { /* fields omitted */ }

Common options of an Open Protocol message.

Methods

impl<'a> MessageOptions<'a>

pub fn id(&self) -> Option<&str>

Get the message ID, if any.

Examples

let mut opt = MessageOptions::new();
opt.set_id("hello")?;
assert_eq!(Some("hello"), opt.id());
opt.clear_id();
assert_eq!(None, opt.id());

pub fn sequence(&self) -> u64

Examples

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

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

pub fn priority(&self) -> i32

Get the message priority.

Examples

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

let opt2 = MessageOptions::new_with_priority(-42);
assert_eq!(-42, opt2.priority());

pub fn set_id(&mut self, id: &'a str) -> Result<(), String>

Set the message ID.

Errors

Returns Err(String) if the ID string is empty or all-whitespace.

Error Examples

let mut opt = MessageOptions::new();
assert_eq!(Err("invalid value: a non-empty, non-whitespace, all-ASCII string required".into()), opt.set_id(""));

Examples

let mut opt = MessageOptions::new();
opt.set_id("hello")?;
assert_eq!(Some("hello"), opt.id());
opt.clear_id();
assert_eq!(None, opt.id());

pub fn clear_id(&mut self)

Set the message ID to None.

Examples

let mut opt = MessageOptions::new();
opt.set_id("hello")?;
assert_eq!(Some("hello"), opt.id());
opt.clear_id();
assert_eq!(None, opt.id());

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());

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<'a> Debug for MessageOptions<'a>

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

Formats the value using the given formatter.

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<'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.

impl<'a> Hash for MessageOptions<'a>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

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.