Struct LinksPacket 

pub struct LinksPacket {
    pub external_references: bool,
    pub sections: Vec<Section>,
}

A decoded binary links packet.

Fields

external_references: bool

Header bit 0: references may be external (Hybrid encoding).

sections: Vec<Section>

The links, section by section.

Implementations

impl LinksPacket

pub fn new(external_references: bool) -> Self

An empty packet.

pub fn pack( external_references: bool, links: &[(u64, Vec<Reference>)], packed_widths: bool, ) -> ProtocolResult<Self>

Lays out links — (address, references) in ascending address order — in as few bytes as the format allows.

Holes between addresses start new sections. Without packed_widths every section uses the width of the widest reference, so all references have the same size. With it each section gets the narrowest width its links need and sections split wherever that saves bytes; the result is never larger than the uniform one.

pub fn links(&self) -> impl Iterator<Item = (u64, &[Reference])> + '_

Every link with its address, in address order.

pub fn link_count(&self) -> u64

The number of links in the packet.

pub fn to_bytes(&self) -> ProtocolResult<Vec<u8>>

Serializes the packet.

pub fn write_to(&self, writer: &mut dyn Write) -> ProtocolResult<()>

Writes the packet to writer.

pub fn from_bytes(bytes: &[u8], limits: &DecodeLimits) -> ProtocolResult<Self>

Parses a complete packet; trailing bytes are an error.

pub fn read_from( reader: &mut dyn Read, limits: &DecodeLimits, ) -> ProtocolResult<Option<Self>>

Reads one packet from reader; Ok(None) on a clean end of stream.

Trait Implementations

impl Clone for LinksPacket

fn clone(&self) -> LinksPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LinksPacket

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

Formats the value using the given formatter.

impl Default for LinksPacket

fn default() -> LinksPacket

Returns the “default value” for a type.

impl Eq for LinksPacket

impl PartialEq for LinksPacket

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for LinksPacket