Struct sn_messaging::client::MsgEnvelope [−][src]
Message envelope containing a Safe message payload, sender, and the list of proxies the message could have been gone through with their signatures. This struct also provides utilities to obtain the serialized bytes ready to send them over the wire. The serialized bytes contain information about messaging protocol version, serialization style used for the payload (e.g. Json), and/or any other information required by the receiving end to either deserialize it, or detect any incompatibility.
Fields
message: Message
The actual message payload
origin: MsgSender
The source of the message.
proxies: Vec<MsgSender>
Intermediate actors, so far, on the path of this message. Every new actor handling this message, would add itself here.
Implementations
impl MsgEnvelope
[src]
pub fn from(bytes: Bytes) -> Result<Self>
[src]
Convinience function to deserialize a 'MsgEnvelope' from bytes received over the wire. It returns an error if the bytes don't correspond to a client message.
pub fn serialize(&self) -> Result<Bytes>
[src]
serialize this MsgEnvelope into bytes ready to be sent over the wire.
pub fn id(&self) -> MessageId
[src]
Gets the message ID.
pub fn verify(&self) -> Result<bool>
[src]
Verify the signature provided by the most recent sender is valid.
pub fn target_section_pk(&self) -> Option<PublicKey>
[src]
Get Message target section's expected PublicKey
pub fn add_proxy(&mut self, proxy: MsgSender)
[src]
The proxy would first sign the MsgEnvelope, and then call this method to add itself (public key + the signature) to the envelope.
pub fn most_recent_sender(&self) -> &MsgSender
[src]
Return the most recent proxy this message passed through, or the sender if it didn't go through any proxy.
pub fn destination(&self) -> Result<Address>
[src]
Return the final destination address for this message.
Trait Implementations
impl Clone for MsgEnvelope
[src]
fn clone(&self) -> MsgEnvelope
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for MsgEnvelope
[src]
impl<'de> Deserialize<'de> for MsgEnvelope
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Eq for MsgEnvelope
[src]
impl PartialEq<MsgEnvelope> for MsgEnvelope
[src]
fn eq(&self, other: &MsgEnvelope) -> bool
[src]
fn ne(&self, other: &MsgEnvelope) -> bool
[src]
impl Serialize for MsgEnvelope
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralEq for MsgEnvelope
[src]
impl StructuralPartialEq for MsgEnvelope
[src]
Auto Trait Implementations
impl RefUnwindSafe for MsgEnvelope
[src]
impl Send for MsgEnvelope
[src]
impl Sync for MsgEnvelope
[src]
impl Unpin for MsgEnvelope
[src]
impl UnwindSafe for MsgEnvelope
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,