Struct mles_utils::Msg

pub struct Msg { /* fields omitted */ }

Msg structure

This structure defines the Mles interface value triplet (uid, channel, message). It is eventually serialized and deserialized by CBOR.

Implementations

impl Msg

pub fn new(uid: String, channel: String, message: Vec<u8>) -> Msg

Create a new Msg object with value triplet.

Example

use mles_utils::Msg;

let msg = Msg::new("My uid".to_string(), "My channel".to_string(), Vec::new());

pub fn set_uid(self, uid: String) -> Msg

Set uid for Msg object.

Example

use mles_utils::Msg;

let mut msg = Msg::new("My uid".to_string(), "My channel".to_string(), Vec::new());
let msg = msg.set_uid("New uid".to_string());

assert_eq!("New uid".to_string(), *msg.get_uid());

pub fn set_channel(self, channel: String) -> Msg

Set channel for Msg object.

Example

use mles_utils::Msg;

let mut msg = Msg::new("My uid".to_string(), "My channel".to_string(), Vec::new());
let msg = msg.set_channel("New channel".to_string());

assert_eq!("New channel".to_string(), *msg.get_channel());

pub fn set_message(self, message: Vec<u8>) -> Msg

Set message for Msg object.

Example

use mles_utils::Msg;

let mut msg = Msg::new("My uid".to_string(), "My channel".to_string(), Vec::new());
let new_message: Vec<u8> = "New message".to_string().into_bytes();
let msg = msg.set_message(new_message);

pub fn get_uid(&self) -> &String

Get uid for Msg object. See example for set uid.

pub fn get_channel(&self) -> &String

Get channel for Msg object. See example for set channel.

pub fn get_message(&self) -> &Vec<u8>

Get message for Msg object.

Example

use mles_utils::Msg;

let mut msg = Msg::new("My uid".to_string(), "My channel".to_string(), Vec::new());
let msg: &Vec<u8> = msg.get_message();

pub fn get_message_len(&self) -> usize

Get message len for Msg object.

Example

use mles_utils::Msg;

let mut msg = Msg::new("My uid".to_string(), "My channel".to_string(), Vec::new());
let msg_len: usize = msg.get_message_len();

pub fn get_mut_message(&mut self) -> &mut Vec<u8>

Get mutable message reference for Msg object.

Example

use mles_utils::Msg;

let mut msg = Msg::new("My uid".to_string(), "My channel".to_string(), "My
message".to_string().into_bytes());
let message = msg.get_mut_message();
message.extend_from_slice(&" is mutable".to_string().into_bytes());

pub fn encode(&self) -> Vec<u8>

Encode Msg object to CBOR.

Errors

If message cannot be encoded, an empty vector is returned.

Example

use mles_utils::Msg;

let msg = Msg::new("My uid".to_string(), "My channel".to_string(), Vec::new());
let encoded_msg: Vec<u8> = msg.encode();

pub fn decode(slice: &[u8]) -> Msg

Decode CBOR byte string to Msg object.

Errors

If message cannot be decoded, a Msg structure with empty items is returned.

Example

use mles_utils::Msg;

let msg = Msg::new("My uid".to_string(), "My channel".to_string(), Vec::new());
let encoded_msg: Vec<u8> = msg.encode();
let decoded_msg: Msg = Msg::decode(&encoded_msg);

Trait Implementations

impl Clone for Msg

fn clone(&self) -> Msg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Msg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Msg

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Msg

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

Serialize this value into the given Serde serializer.