Struct sesstype::Message

pub struct Message { /* fields omitted */ }

A structure to represent a message passed between Roles.

A Message consists of a label, and optionally, a PayloadType embedded in the Message. Note that the payload types are not real types but String symbols that map to sorts.

Message should never be shared.

Methods

impl Message

fn new(label: &str) -> Message

Creates a new Message with the given label.

The Message created by this method will have an empty PayloadType.

Example

use sesstype::Message;

let _msg = Message::new("label"); // label()

fn label(&self) -> &String

Returns the label of the Message.

Example

use sesstype::Message;

let msg = Message::new("label"); // label()
let _msg_label = msg.label(); // "label"

fn with_payload_type(label: &str, payload: &str) -> Message

Creates a Message with a base type payload.

Example

use sesstype::Message;

let _msg = Message::with_payload_type("label", "int"); // label(int)

fn with_payload_session(label: &str, payload: Box<Type>) -> Message

Creates a Message with a session type payload.

Example

use sesstype::Message;
use sesstype::local;

let _msg = Message::with_payload_session("label", local::Type::end()); // label(end)

Trait Implementations

impl Debug for Message

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

Formats the value using the given formatter.

impl Clone for Message

fn clone(&self) -> Message

Returns a copy of the value.

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

Performs copy-assignment from source.

impl ToString for Message

fn to_string(&self) -> String

Converts Message into a human friendly String representation.

The format of the String representation is Label(payload)

impl PartialEq for Message

fn eq(&self, other: &Message) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Eq for Message

impl Hash for Message

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