Struct safe_network::messaging::serialisation::WireMsg

pub struct WireMsg { /* fields omitted */ }

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.

Implementations

impl WireMsg

pub fn new_section_info_msg(
    query: &SectionInfoMsg,
    dst: XorName,
    dst_section_pk: PublicKey
) -> Result<Self>

Creates a new instance keeping a (serialized) copy of the ‘SectionInfo’ message provided.

pub fn new_client_msg(
    msg: &ClientMsg,
    dst: XorName,
    dst_section_pk: PublicKey
) -> Result<Self>

Creates a new instance keeping a (serialized) copy of the client ‘Message’ message provided.

pub fn new_routing_msg(
    msg: &RoutingMsg,
    dst: XorName,
    dst_section_pk: PublicKey
) -> Result<Self>

Creates a new instance keeping a (serialized) copy of the node ‘Message’ message provided.

pub fn new_node_msg(
    msg: &NodeMsg,
    dst: XorName,
    dst_section_pk: PublicKey,
    src_section_pk: Option<PublicKey>
) -> Result<Self>

Creates a new instance keeping a (serialized) copy of the node ‘Message’ message provided.

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 is_join_request(&self) -> Result<bool>

Returns true if the message is a JoinRequest.

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 to_message(&self) -> Result<MessageType>

Deserialize the payload from this WireMsg returning a Message instance.

pub fn msg_id(&self) -> MessageId

Return the message id of this message

pub fn dst_section_pk(&self) -> PublicKey

Return the destination section PublicKey for this message

pub fn dst(&self) -> XorName

Return the destination for this message

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

Return the source section PublicKey for this message if it’s a NodeMsg and it was provided in the header of message.

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

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

pub fn serialize_section_info_msg(
    query: &SectionInfoMsg,
    dst: XorName,
    dst_section_pk: PublicKey
) -> Result<Bytes>

Convenience function which creates a temporary WireMsg from the provided MsgEnvelope, returning the serialized WireMsg.

pub fn serialize_client_msg(
    msg: &ClientMsg,
    dst: XorName,
    dst_section_pk: PublicKey
) -> Result<Bytes>

Convenience function which creates a temporary WireMsg from the provided Message, returning the serialized WireMsg.

pub fn serialize_routing_msg(
    msg: &RoutingMsg,
    dst: XorName,
    dst_section_pk: PublicKey
) -> Result<Bytes>

Convenience function which creates a temporary WireMsg from the provided node::Messsage, returning the serialized WireMsg.

pub fn serialize_node_msg(
    msg: &NodeMsg,
    dst: XorName,
    dst_section_pk: PublicKey,
    src_section_pk: Option<PublicKey>
) -> Result<Bytes>

Convenience function which creates a temporary WireMsg from the provided node::Node, returning the serialized WireMsg.

pub fn update_dst_info(
    &mut self,
    dst_pk: Option<PublicKey>,
    dst: Option<XorName>
)

Update dst_pk and or dst in the WireMsg

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: &WireMsg) -> bool

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

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

This method tests for !=.

impl StructuralPartialEq for WireMsg