Enum BodyLength

pub enum BodyLength {
    Full(u32),
    Partial(u32),
    Indeterminate,
}

A packet’s size.

A packet’s size can be expressed in three different ways. Either the size of the packet is fully known (Full), the packet is chunked using OpenPGP’s partial body encoding (Partial), or the packet extends to the end of the file (Indeterminate). See Section 4.2 of RFC 9580 for more details.

Variants

Full(u32)

The packet’s size is known.

Partial(u32)

The parameter is the number of bytes in the current chunk.

This type is only used with new format packets.

Indeterminate

The packet extends until an EOF is encountered.

This type is only used with old format packets.

Implementations

impl BodyLength

pub fn serialize_old<W: Write + ?Sized>(&self, o: &mut W) -> Result<()>

Emits the length encoded for use with old-style CTBs.

Note: the CTB itself is not emitted.

Errors

Returns Error::InvalidArgument if invoked on BodyLength::Partial. If you want to serialize a new-style length, use serialize(..).

Trait Implementations

impl Clone for BodyLength

fn clone(&self) -> BodyLength

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BodyLength

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

Formats the value using the given formatter.

impl Marshal for BodyLength

fn serialize(&self, o: &mut dyn Write) -> Result<()>

Emits the length encoded for use with new-style CTBs.

Note: the CTB itself is not emitted.

Errors

Returns Error::InvalidArgument if invoked on BodyLength::Indeterminate. If you want to serialize an old-style length, use serialize_old(..).

fn export(&self, o: &mut dyn Write) -> Result<()>

Exports a serialized version of the object to o.

impl MarshalInto for BodyLength

fn serialized_len(&self) -> usize

Computes the maximal length of the serialized representation.

fn serialize_into(&self, buf: &mut [u8]) -> Result<usize>

Serializes into the given buffer.

fn to_vec(&self) -> Result<Vec<u8>>

Serializes the packet to a vector.

fn export_into(&self, buf: &mut [u8]) -> Result<usize>

Exports into the given buffer.

fn export_to_vec(&self) -> Result<Vec<u8>>

Exports to a vector.

impl PartialEq for BodyLength

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for BodyLength

impl StructuralPartialEq for BodyLength