Struct routing::messaging::MpidMessage

pub struct MpidMessage { /* fields omitted */ }

A full message including header and body which can be sent to or retrieved from the network.

Methods

impl MpidMessage

pub fn new(     sender: XorName,     metadata: Vec<u8>,     recipient: XorName,     body: Vec<u8>,     secret_key: &SecretKey ) -> Result<MpidMessage, Error>

Constructor.

sender and metadata are used to construct an MpidHeader member, accessed via the header() getter. For details on these arguments, see MpidHeader::new().

recipient represents the name of the intended receiver of the message.

body is arbitrary, user-supplied data representing the main portion of the message. It must not exceed MAX_BODY_SIZE. It can be empty if desired.

An error will be returned if body exceeds MAX_BODY_SIZE, if MpidHeader::new() fails or if serialisation during the signing process fails.

pub fn header(&self) -> &MpidHeader

Getter for MpidHeader member, created when calling new().

pub fn recipient(&self) -> &XorName

The name of the intended receiver of the message.

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

Arbitrary, user-supplied data representing the main portion of the message.

pub fn name(&self) -> Result<XorName, Error>

The name of the message, equivalent to the MpidHeader::name(). As per that getter, this is relatively expensive, so its use should be minimised.

pub fn verify(&self, public_key: &PublicKey) -> bool

Validates the message and header signatures against the provided PublicKey.

Trait Implementations

impl PartialEq for MpidMessage

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

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

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

This method tests for !=.

impl Eq for MpidMessage

impl Hash for MpidMessage

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 Clone for MpidMessage

fn clone(&self) -> MpidMessage

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MpidMessage

fn fmt(&self, formatter: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.