Struct sn_messaging::WireMsg

pub struct WireMsg { /* fields omitted */ }

Implementations

impl WireMsg

pub fn new_ping_msg(dest: XorName, dest_section_pk: PublicKey) -> Self

Creates a new instance of a ‘Ping’ message.

pub fn new_section_info_msg(
    query: &Message,
    dest: XorName,
    dest_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,
    dest: XorName,
    dest_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,
    dest: XorName,
    dest_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,
    dest: XorName,
    dest_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 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 dest_section_pk(&self) -> PublicKey

Return the destination section PublicKey for this message

pub fn dest(&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: &Message,
    dest: XorName,
    dest_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,
    dest: XorName,
    dest_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,
    dest: XorName,
    dest_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,
    dest: XorName,
    dest_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.

Trait Implementations

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