Struct Packet

pub struct Packet { /* private fields */ }

Represents a packet to be sent out.

Note that each piece of the packet is associated with a key. The keys don’t have to be unique – more than one piece can be associated with a single key. For example, if a node is meant to both receive a message and transport the packet further, those two might be encrypted with the same key.

Implementations

impl Packet

pub fn unsigned() -> Packet

Creates a packet whose chunks won’t be signed.

pub fn signed(skey: SecretKey) -> Packet

Creates a packet whose chunks will be signed by the given key.

pub fn reply_to(&mut self, msg: &Message) -> Result<()>

If the message has a reply block, adds it to this packet’s instructions.

If the message doesn’t have a reply block, the packet is unchanged.

Note that the reply block is pre-encrypted and, if applicable, pre-signed by the original sender. The contents will not be signed, even if this packet is a signed one.

pub fn add_message(&mut self, data: &[u8], node_pkey: &PublicKey)

Adds a message to the packet, for the node with the right skey to read.

pub fn add_hop(&mut self, path: String, node_pkey: &PublicKey)

Adds a hop to the packet, so that when it reaches the node with the right skey, it’ll get forwarded along the given path.

pub fn add_reply_path(&mut self) -> Option<ReplyPathHandle<'_>>

Starts creating a reply path.

Trait Implementations

impl Clone for Packet

fn clone(&self) -> Packet

Returns a duplicate of the value.

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

Performs copy-assignment from source.