Struct EnvelopeHeader 

pub struct EnvelopeHeader {
    pub format: EnvelopeFormat,
    pub zstd: bool,
}

Header at the start of a binary envelope file.

See the crate::envelope module documentation for the binary format.

Fields

format: EnvelopeFormat

The format used for the payload.

zstd: bool

Whether the payload is compressed with zstd.

Implementations

impl EnvelopeHeader

pub fn config(&self) -> EnvelopeConfig

Returns the envelope configuration corresponding to this header.

Note that zstd compression level is not stored in the header.

pub fn write(&self, writer: &mut impl Write) -> Result<(), EnvelopeError>

Write an envelope header to a writer.

See the crate::envelope module documentation for the binary format.

pub fn read(reader: &mut impl Read) -> Result<EnvelopeHeader, HeaderError>

Reads an envelope header from a reader.

Consumes exactly 10 bytes from the reader. See the crate::envelope module documentation for the binary format.

Trait Implementations

impl Clone for EnvelopeHeader

fn clone(&self) -> EnvelopeHeader

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnvelopeHeader

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

Formats the value using the given formatter.

impl Default for EnvelopeHeader

fn default() -> EnvelopeHeader

Returns the “default value” for a type.

impl Display for EnvelopeHeader

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

Formats the value using the given formatter.

impl PartialEq for EnvelopeHeader

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

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

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 EnvelopeHeader

impl Eq for EnvelopeHeader

impl StructuralPartialEq for EnvelopeHeader