Struct rust_ipv8::serialization::Packet

pub struct Packet(pub Vec<u8>);

The packet struct containing the bytes of a packet in a Vec<u8>.

Methods

impl Packet

pub fn new(header: Header) -> Result<Self, Box<dyn Error>>

Creates a new packet with a given header.

pub fn raw(&self) -> &[u8]

Extracts the raw byte contents from a packet.

pub fn sign(self, keypair: &KeyPair) -> Result<Self, Box<dyn Error>>

Signs a packet. After this, new payloads must under no circumstances be added as this will break the verification process on the receiving end. There is no check for this by design for a speed boost (though this may or may not be revisited later). Sign deliberately consumes self and returns it again so it can be assigned to a new, immutable variable to never be changed again.

Verification of this signature can only happen when a public key is known at the receiving end. The user of the rust-ipv8 library is responsible for this to already have been packed into the final packet or alternatively already known by the receiver.

To verify signatures first transform the Packet into a PacketIterator with Packet.deserialize_multiple and then use the PacketIterator.verify() or PacketIterator.verify_with() method.

pub fn start_deserialize(self) -> PacketDeserializer

Deserializes a stream of bytes into ipv8 payloads.

pub fn add<T>(&mut self, obj: &T) -> Result<(), Box<ErrorKind>> where
    T: Ipv8Payload + Serialize, 

Adds a payload to a packet. This serializes payloads.

Trait Implementations

impl PartialEq<Packet> for Packet

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

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

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

This method tests for !=.

impl Clone for Packet

fn clone(&self) -> Packet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Packet

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

Formats the value using the given formatter.

impl Serialize for Packet

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for Packet

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

Deserialize this value from the given Serde deserializer.