Struct rings_node::prelude::message::MessagePayload

pub struct MessagePayload<T> {
    pub data: T,
    pub tx_id: Uuid,
    pub addr: Did,
    pub relay: MessageRelay,
    pub verification: MessageVerification,
    pub origin_verification: MessageVerification,
}

All messages transmitted in RingsNetwork should be wrapped by MessagePayload. It additionally offer transaction ID, origin did, relay, previous hop verification, and origin verification.

Fields

data: T

Payload data

tx_id: Uuid

The transaction ID of payload. Remote peer should use same tx_id when response.

addr: Did

The did of payload account, usually it’s last sender.

relay: MessageRelay

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

verification: MessageVerification

This field hold a signature from a node, which is used to prove that the message was sent from that node.

origin_verification: MessageVerification

Same as verification, but the signature was from the original sender.

Implementations

impl<T> MessagePayload<T>where T: Serialize + DeserializeOwned,

pub fn new( data: T, session_sk: &SessionSk, origin_verification_gen: OriginVerificationGen, relay: MessageRelay ) -> Result<MessagePayload<T>, Error>

Create new instance

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

Create new Payload for send

pub fn is_expired(&self) -> bool

Checks whether the payload is expired.

pub fn verify(&self) -> bool

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

pub fn origin_account_did(&self) -> Result<Did, Error>

Get Did from the origin verification.

pub fn account_did(&self) -> Result<Did, Error>

Get did from sender verification.

pub fn from_bincode(data: &[u8]) -> Result<MessagePayload<T>, Error>

Deserializes a MessagePayload instance from the given binary data.

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

Serializes the MessagePayload instance into binary data.

pub fn sender(&self) -> Result<Did, Error>

Did of Sender

pub fn origin(&self) -> Result<Did, Error>

Did of Origin

Trait Implementations

impl<T> Clone for MessagePayload<T>where T: Clone,

fn clone(&self) -> MessagePayload<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for MessagePayload<T>where T: Debug,

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

Formats the value using the given formatter.

impl<T> Decoder for MessagePayload<T>where T: Serialize + DeserializeOwned,

fn from_encoded(encoded: &Encoded) -> Result<MessagePayload<T>, Error>

impl<'de, T> Deserialize<'de> for MessagePayload<T>where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D ) -> Result<MessagePayload<T>, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Encoder for MessagePayload<T>where T: Serialize + DeserializeOwned,

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

impl<T> PartialEq<MessagePayload<T>> for MessagePayload<T>where T: PartialEq<T>,

fn eq(&self, other: &MessagePayload<T>) -> 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<T> Serialize for MessagePayload<T>where T: Serialize,

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

Serialize this value into the given Serde serializer.

impl<T> TryFrom<MessagePayload<T>> for VirtualNodewhere T: Serialize + DeserializeOwned,

type Error = Error

The type returned in the event of a conversion error.

fn try_from(msg: MessagePayload<T>) -> Result<VirtualNode, Error>

Performs the conversion.

impl<T> Eq for MessagePayload<T>where T: Eq,

impl<T> StructuralEq for MessagePayload<T>

impl<T> StructuralPartialEq for MessagePayload<T>