Struct rust_ipv8::serialization::PacketDeserializer

pub struct PacketDeserializer {
    pub pntr: Packet,
    pub index: usize,
}

The main deserializer which iterates over a packet to deserialize it.

This provides multipile helper methods for deserializing packets.

Fields

pntr: Packet

The current packet being deserialize

index: usize

The index in the vector keeping track how far along we are deserializing.

Methods

impl PacketDeserializer

iterates over a packet to extract it's possibly multiple payloads

pub fn next_payload<T>(&mut self) -> Result<T, Box<ErrorKind>> where
    T: Deserialize<'de> + Ipv8Payload + Serialize, 

Deserializes a stream of bytes into an ipv8 payload. Which payload is inferred by the type of T which is generic. T has to be deserializable and implement the Ipv8Payload trait.

pub fn peek_header(&self) -> Result<Header, Box<ErrorKind>>

Returns the header of a packet without removing it

pub fn pop_header(&mut self) -> Result<Header, Box<ErrorKind>>

Returns the header of a packet and removes it

pub fn skip_header(self) -> Result<Self, Box<ErrorKind>>

Just skips over the header returning self

pub fn verify(&mut self) -> bool

This should be in most cases the first method to be called when receiving a packet. It assumes there is a BinMemberAuthenticationPayload at the start of the message (AND DOES NOT CHECK IF IT IS OR NOT). It extracts it and the with the sign put at the end by the sender by calling Packet.sign() verifies that the packet is still inyhtact.

If the public key has been acquired in any other way (i.e. there is no BinMemberAuthenticationPayload at the start) use the Packet.verify_with() function instead.

pub fn verify_with(&mut self, pkey: Ed25519PublicKey) -> bool

Does the same thing as the Packet. verify method. Takes a public key as second argument instead of extracting it from the packet itself through a BinMemberAuthenticationPayload

Trait Implementations

impl PartialEq<PacketDeserializer> for PacketDeserializer

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

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

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

This method tests for !=.

impl Debug for PacketDeserializer

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

Formats the value using the given formatter.