Struct safe_network::messaging::WireMsg

pub struct WireMsg {
    pub header: WireMsgHeader,
    pub payload: Bytes,
}

In order to send a message over the wire, it needs to be serialized along with a header (WireMsgHeader) which contains the information needed by the recipient to properly deserialize it. The WireMsg struct provides the utilities to serialize and deserialize messages.

Fields

header: WireMsgHeader

Message header

payload: Bytes

Serialised message

Implementations

impl WireMsg

pub fn serialize_msg_payload<T: Serialize>(msg: &T) -> Result<Bytes>

Serializes the message provided. This function shall be used to obtain the serialized payload which is needed to create the MsgKind. Once the caller obtains both the serialized payload and MsgKind, it can invoke the new_msg function to instantiate a WireMsg.

pub fn new_msg(
    msg_id: MessageId,
    payload: Bytes,
    msg_kind: MsgKind,
    dst_location: DstLocation
) -> Result<Self>

Creates a new WireMsg with the provided serialized payload and MsgKind.

pub fn from(bytes: Bytes) -> Result<Self>

Attempts to create an instance of WireMsg by deserialising the bytes provided. To succeed, the bytes should contain at least a valid WireMsgHeader.

pub fn serialize(&self) -> Result<Bytes>

Return the serialized WireMsg, which contains the WireMsgHeader bytes, followed by the payload bytes, i.e. the serialized Message.

pub fn into_message(&self) -> Result<MessageType>

Deserialize the payload from this WireMsg returning a MessageType instance.

pub fn msg_id(&self) -> MessageId

Return the message id of this message

pub fn set_msg_id(&mut self, msg_id: MessageId)

Update the message ID

pub fn msg_kind(&self) -> &MsgKind

Return the kind of this message

pub fn dst_section_pk(&self) -> Option<BlsPublicKey>

Return the destination section PublicKey for this message

pub fn set_dst_section_pk(&mut self, pk: BlsPublicKey)

Update the destination section PublicKey for this message

pub fn set_dst_xorname(&mut self, name: XorName)

Update the destination XorName for this message

pub fn dst_location(&self) -> &DstLocation

Return the destination for this message

pub fn src_section_pk(&self) -> Option<BlsPublicKey>

Return the source section PublicKey for this message if it’s a NodeMsg

pub fn deserialize(bytes: Bytes) -> Result<MessageType>

Convenience function which creates a temporary WireMsg from the provided bytes, returning the deserialized message.

pub fn verify_sig(
    auth: ServiceAuth,
    msg: ServiceMsg
) -> Result<AuthorityProof<ServiceAuth>>

Convenience function which validates the signature on a ServiceMsg.

Trait Implementations

impl Clone for WireMsg

fn clone(&self) -> WireMsg

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WireMsg

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

Formats the value using the given formatter.

impl PartialEq<WireMsg> for WireMsg

fn eq(&self, other: &Self) -> 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 !=.