Struct Message

pub struct Message {
    pub source_public_key: Vec<u8>,
    pub destination_public_key: Vec<u8>,
    pub received_time: i64,
    pub payload_digest: Vec<u8>,
    pub stamp: Option<Stamp>,
    pub scheme: i32,
    pub salt: Vec<u8>,
    pub payload_hmac: Vec<u8>,
    pub payload_size: u64,
    pub payload: Vec<u8>,
}

The primary message used in communication over the relay protocol.

Fields

source_public_key: Vec<u8>

The source public key.

destination_public_key: Vec<u8>

The destinations public key.

received_time: i64

Maleable server time.

payload_digest: Vec<u8>

The SHA-256 digest of the payload.

stamp: Option<Stamp>

The stamp attached to the message.

scheme: i32

The encryption scheme used on the serialized Payload to produce the payload field.

salt: Vec<u8>

The salt is used to salt both the payload_hmac and the encryption key.

payload_hmac: Vec<u8>

The HMAC of the payload, specifically HMAC(HMAC(sdG, salt), payload_digest).

payload_size: u64

The size, in bytes, of the payload.

payload: Vec<u8>

The encrypted payload.

Implementations

impl Message

pub fn scheme(&self) -> EncryptionScheme

Returns the enum value of scheme, or the default if the field is set to an invalid enum value.

pub fn set_scheme(&mut self, value: EncryptionScheme)

Sets scheme to the provided enum value.

impl Message

pub fn digest(&self) -> Result<[u8; 32], DigestError>

Get the SHA-256 digest of the payload, if payload_digest is missing then calculate it.

pub fn parse(self) -> Result<ParsedMessage, ParseError>

Parse the Message to construct a ParsedMessage.

The involves deserialization of both public keys, calculation of the payload digest, and coercion of byte fields into arrays.

Trait Implementations

impl Clone for Message

fn clone(&self) -> Message

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Message

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

Formats the value using the given formatter.

impl Default for Message

fn default() -> Self

Returns the “default value” for a type.

impl Message for Message

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message to a buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn decode<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Message

fn eq(&self, other: &Message) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Message