Struct sequoia_openpgp::packet::header::Header

pub struct Header { /* private fields */ }

A packet’s header.

See Section 4.2 of RFC 4880 for details.

Implementations

impl Header

pub fn new(ctb: CTB, length: BodyLength) -> Self

Creates a new header.

pub fn ctb(&self) -> &CTB

Returns the header’s CTB.

pub fn length(&self) -> &BodyLength

Returns the header’s length.

pub fn valid(&self, future_compatible: bool) -> Result<()>

Checks the header for validity.

A header is consider invalid if:

• The tag is Tag::Reserved.
• The tag is Tag::Unknown or Tag::Private and future_compatible is false.
• The length encoding is invalid for the packet (e.g., partial body encoding may not be used for PKESK packets)
• The lengths are unreasonable for a packet (e.g., a PKESK or SKESK larger than 10 KB).

Trait Implementations

impl Clone for Header

fn clone(&self) -> Header

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Header

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

Formats the value using the given formatter.

impl Marshal for Header

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

Writes a serialized version of the object to o.

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

Exports a serialized version of the object to o.

impl MarshalInto for Header

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<'a> Parse<'a, Header> for Header

fn from_reader<R: 'a + Read + Send + Sync>(reader: R) -> Result<Self>

Parses an OpenPGP packet’s header as described in Section 4.2 of RFC 4880.

fn from_file<P: AsRef<Path>>(path: P) -> Result<T>

Reads from the given file.

fn from_bytes<D: AsRef<[u8]> + ?Sized + Send + Sync>(data: &'a D) -> Result<T>

Reads from the given slice.