Struct tari_comms_dht::envelope::DhtHeader

pub struct DhtHeader {
    pub version: u32,
    pub origin_mac: Vec<u8>,
    pub ephemeral_public_key: Vec<u8>,
    pub message_type: i32,
    pub network: i32,
    pub flags: u32,
    pub message_tag: u64,
    pub destination: Option<Destination>,
}

Fields

version: u32

origin_mac: Vec<u8>

Origin public key of the message. This can be the same peer that sent the message or another peer if the message should be forwarded. This is optional but MUST be specified if the ENCRYPTED flag is set. If an ephemeral_public_key is specified, this MUST be encrypted using a derived ECDH shared key

ephemeral_public_key: Vec<u8>

Ephemeral public key component of the ECDH shared key. MUST be specified if the ENCRYPTED flag is set.

message_type: i32

The type of message

network: i32

The network for which this message is intended (e.g. TestNet, MainNet etc.)

flags: u32

message_tag: u64

Message trace ID TODO: Remove for mainnet or when testing message traces is not required

destination: Option<Destination>

Implementations

impl DhtHeader

pub fn message_type(&self) -> DhtMessageType

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

pub fn set_message_type(&mut self, value: DhtMessageType)

Sets message_type to the provided enum value.

pub fn network(&self) -> Network

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

pub fn set_network(&mut self, value: Network)

Sets network to the provided enum value.

Trait Implementations

impl Clone for DhtHeader

fn clone(&self) -> DhtHeader

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DhtHeader

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

Formats the value using the given formatter.

impl Default for DhtHeader

fn default() -> DhtHeader

Returns the "default value" for a type.

impl From<DhtMessageHeader> for DhtHeader

fn from(header: DhtMessageHeader) -> Self

Performs the conversion.

impl Message for DhtHeader

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<DhtHeader> for DhtHeader

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for DhtHeader

impl TryFrom<DhtHeader> for DhtMessageHeader

type Error = DhtMessageError

The type returned in the event of a conversion error.

fn try_from(header: DhtHeader) -> Result<Self, Self::Error>

Performs the conversion.