Skip to main content

CodecId

Enum CodecId 

Source
#[non_exhaustive]
#[repr(u8)]
pub enum CodecId { Store = 0, Deflate = 1, Lz4 = 2, Snappy = 3, Zstd = 4, Lzma = 5, }
Expand description

Names the compression applied to an entry’s payload.

Stored in the low nibble of an entry’s first byte, so the format admits at most sixteen codecs and every id below is permanently assigned. Which of them a given build can actually use is a separate question, decided by embark-codec’s cargo features: an id naming a codec that was not compiled in parses fine here and fails at decompression time with Error::UnknownCodec.

#[non_exhaustive]: this list has already grown from two variants to six and the format has room for ten more, so match it with a wildcard arm that reports Error::UnknownCodec rather than one that silently picks a default.

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Store = 0

No compression: the payload is the original bytes verbatim.

Also the fallback the build-time encoders pick whenever the chosen codec would have made the file larger.

§

Deflate = 1

Raw DEFLATE (RFC 1951), with no zlib or gzip wrapper.

§

Lz4 = 2

LZ4 block format, without the frame header.

§

Snappy = 3

Snappy block format, including its length preamble.

§

Zstd = 4

Zstandard, as a complete single-frame stream.

§

Lzma = 5

LZMA1 in the .lzma “alone” container, header included.

Implementations§

Source§

impl CodecId

Source

pub fn as_u8(self) -> u8

The byte written to the low nibble of an entry’s tag byte.

Source

pub fn from_u8(v: u8) -> Result<CodecId>

Reads a codec id back out of an entry’s tag byte.

§Errors

Returns Error::UnknownCodec if v is not an assigned id. Entry bytes are untrusted input, so this is an ordinary runtime outcome rather than a sign of a bug.

Trait Implementations§

Source§

impl Clone for CodecId

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for CodecId

Source§

impl Debug for CodecId

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for CodecId

Source§

impl PartialEq for CodecId

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for CodecId

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.