Struct rings_core::message::MessagePayload

pub struct MessagePayload {
    pub transaction: Transaction,
    pub relay: MessageRelay,
    pub verification: MessageVerification,
}

MessagePayload is used to transmit data between nodes. The data should be packed by Transaction.

Fields

transaction: Transaction

Payload data

relay: MessageRelay

Relay records the transport path of message. And can also help message sender to find the next hop.

verification: MessageVerification

This field holds a signature from a node, which is used to prove that payload was created by that node.

Implementations

impl MessagePayload

pub fn new( transaction: Transaction, session_sk: &SessionSk, relay: MessageRelay ) -> Result<Self>

Create new MessagePayload. Need Transaction, SessionSk and MessageRelay.

pub fn new_send<T>( data: T, session_sk: &SessionSk, next_hop: Did, destination: Did ) -> Result<Self>

where T: Serialize,

Helps to create sending message from data.

pub fn from_bincode(data: &[u8]) -> Result<Self>

Deserializes a MessagePayload instance from the given binary data.

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

Serializes the MessagePayload instance into binary data.

Trait Implementations

impl Clone for MessagePayload

fn clone(&self) -> MessagePayload

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for MessagePayload

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

Formats the value using the given formatter.

impl Decoder for MessagePayload

fn from_encoded(encoded: &Encoded) -> Result<Self>

impl<'de> Deserialize<'de> for MessagePayload

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Encoder for MessagePayload

fn encode(&self) -> Result<Encoded>

impl MessageVerificationExt for MessagePayload

fn verification_data(&self) -> Result<Vec<u8>>

Give the data to be verified.

fn verification(&self) -> &MessageVerification

Give the verification field for verifying.

fn is_expired(&self) -> bool

Checks whether the message is expired.

fn verify(&self) -> bool

Verifies that the message is not expired and that the signature is valid.

fn signer(&self) -> Did

Get signer did from verification.

impl PartialEq for MessagePayload

fn eq(&self, other: &MessagePayload) -> 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 !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for MessagePayload

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<MessagePayload> for VirtualNode

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: MessagePayload) -> Result<Self>

Performs the conversion.

impl Eq for MessagePayload

impl StructuralPartialEq for MessagePayload