Struct rust_ipv8::serialization::header::Header

pub struct Header {
    pub size: usize,
    pub version: HeaderVersion,
    pub mid_hash: Option<Vec<u8>>,
    pub message_type: Option<u64>,
}

The struct for headers.

The mid_hash and message_type are Options and larger then they need to be for easier expansion later on.

Fields

size: usize

This is a size that is hardcoded when a header is deserialized.

version: HeaderVersion

The version of the packet, 1 is dispersy and 2 is py-ipv8, could be increased to 3 for rust specific enhancements in the future

mid_hash: Option<Vec<u8>>

The hash of the master peer of a community, used to identify to which community the packets belongs

message_type: Option<u64>

Specifies the type of messsage, can be used by communities to distinguish between packets

Methods

impl Header

pub fn py_ipv8_header(mid_hash: [u8; 20], message_type: u8) -> Self

Helper function for creating a PyIPv8 compliant Header

Trait Implementations

impl PartialEq<Header> for Header

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

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

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

This method tests for !=.

impl Debug for Header

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

Formats the value using the given formatter.

impl Serialize for Header

makes the Header serializable.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error> where
    S: Serializer, 

All types of headers need to be serialized differently

impl<'de> Deserialize<'de> for Header

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error> where
    D: Deserializer<'de>, 

deserializes a Header