Struct TransportMsgHeader 

pub struct TransportMsgHeader {
    pub version: u8,
    pub encrypt: bool,
    pub route: RouteRule,
    pub ttl: u8,
    pub feature: u8,
    pub meta: u8,
    pub from_node: Option<u32>,
}

Fixed Header Fields

    0                   1                   2                   3
    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |V=0|E|N|   R   |      TTL      |  Feature       |     Meta     |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                         Route destination (Opt)               |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                         FromNodeId (Opt)                      |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

In there

• Version (V) : 2 bits (now is 0)

• Encrypt (E): 1 bits, If this bit is set, this msg should be encrypted

• From Node (N) : 1 bits, If this bit is set, from node_id will occupy 32 bits in header

• Route Type (R): 4 bits

  • 0: Direct : which node received this msg will handle it, no route destination
  • 1: ToNode : which node received this msg will route it to node_id
  • 2: ToService : which node received this msg will route it to service meta
  • 3: ToKey : which node received this msg will route it to key
  • .. Not used

• Ttl (TTL): 8 bits

• Feature Id: 8 bits

• Route destination (Route Destination): 32 bits (if R is not Direct)

  • If route type is ToNode, this field is 32bit node_id
  • If route type is ToService, this field is 32bit service meta
  • If route type is ToKey, this field is 32bit key

• From Node Id: 32 bits (optional if N bit is set)

Fields

version: u8

encrypt: bool

route: RouteRule

ttl: u8

feature: u8

meta: u8

from_node: Option<u32>

Which can be anonymous or specific node

Implementations

impl TransportMsgHeader

pub fn is_secure(first_byte: u8) -> bool

pub fn new() -> TransportMsgHeader

Builds a message with the given service_id, route rule.

pub fn build(feature: u8, meta: u8, route: RouteRule) -> TransportMsgHeader

pub fn set_ttl(self, ttl: u8) -> TransportMsgHeader

Set ttl

pub fn set_encrypt(self, encrypt: bool) -> TransportMsgHeader

Set secure

pub fn set_from_node(self, from_node: Option<u32>) -> TransportMsgHeader

Set from node

pub fn set_feature(self, feature: u8) -> TransportMsgHeader

Set to feature

pub fn set_meta(self, meta: u8) -> TransportMsgHeader

Set to service_id

pub fn set_route(self, route: RouteRule) -> TransportMsgHeader

Set rule

pub fn to_bytes(&self, output: &mut [u8]) -> Option<usize>

Converts the message to a byte representation and appends it to the given output vector.

Arguments

• output - A mutable vector of bytes to append the serialized message to.

Returns

An Option containing the number of bytes written if the output vector was large enough, or None if the output vector was too small.

pub fn rewrite_ttl(buf: &mut [u8], new_ttl: u8) -> Option<()>

Rewrite the ttl in the given buffer with the new ttl.

Arguments

• buf - A mutable slice of bytes representing the buffer to rewrite the ttl in.
• new_ttl - The new ttl to use for rewriting the ttl.

Returns

An Option containing () if the ttl was successfully rewritten, or None if the buffer is too small to hold the new ttl.

pub fn decrease_ttl(buf: &mut [u8]) -> bool

Decrease the ttl in the given buffer.

Arguments

• buf - A mutable slice of bytes representing the buffer to decrease the ttl in.

Returns

An Option containing () if the ttl was successfully decreased, or None if the buffer is too small to hold the new ttl or ttl too small.

pub fn serialize_size(&self) -> usize

Returns the size of the serialized message.

Trait Implementations

impl Clone for TransportMsgHeader

fn clone(&self) -> TransportMsgHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TransportMsgHeader

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

Formats the value using the given formatter.

impl Default for TransportMsgHeader

fn default() -> TransportMsgHeader

Returns the “default value” for a type.

impl From<&TransportMsgHeader> for NetIncomingMeta

fn from(value: &TransportMsgHeader) -> NetIncomingMeta

Converts to this type from the input type.

impl PartialEq for TransportMsgHeader

fn eq(&self, other: &TransportMsgHeader) -> 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 TryFrom<&[u8]> for TransportMsgHeader

type Error = TransportMsgHeaderError

The type returned in the event of a conversion error.

fn try_from( bytes: &[u8], ) -> Result<TransportMsgHeader, <TransportMsgHeader as TryFrom<&[u8]>>::Error>

Performs the conversion.

impl Eq for TransportMsgHeader

impl StructuralPartialEq for TransportMsgHeader