Skip to main content

Codec

Struct Codec 

Source
pub struct Codec { /* private fields */ }
Expand description

Reusable codec state for one worker.

Two things live here that must not be rebuilt per chunk:

  • zstd contexts. A CCtx owns the match tables — megabytes at level 3. The convenience zstd::bulk::compress_to_buffer allocates and frees one on every call, which on 1 MiB chunks costs more than the compression itself.
  • A scratch buffer. zstd needs a destination sized to its worst case. Growing a Vec for that means zeroing ~1 MiB per chunk that the codec is about to overwrite anyway. One long-lived buffer pays that once.

Implementations§

Source§

impl Codec

Source

pub fn new() -> Self

Source

pub fn compress_into( &mut self, cfg: &CompressionConfig, hint: FileHint, input: &[u8], out: &mut Vec<u8>, ) -> Result<Encoded>

Compress input, appending the result to out.

Returns the algorithm actually used, which may be None even when a codec was requested: if the result did not beat min_gain, the raw bytes are written instead. The caller must record the returned algorithm on the wire.

Source

pub fn compress_in_place( &mut self, cfg: &CompressionConfig, hint: FileHint, buf: &mut Vec<u8>, prefix: usize, ) -> Result<Encoded>

Compress the payload already sitting in buf after prefix header bytes.

The sender reads each chunk straight into its frame buffer, so the common case — a chunk that will not be compressed, which is every chunk of a .flac or .mp4 — costs zero copies. Only a chunk that actually wins pays one, and then only of its compressed size.

Source

pub fn decompress_into( &mut self, algo: Algorithm, raw_len: usize, input: &[u8], out: &mut Vec<u8>, ) -> Result<()>

Decompress one chunk. raw_len comes from the frame header and is validated against the decoded length, so a lying sender cannot make us over-allocate beyond the frame limit the caller already enforced.

Trait Implementations§

Source§

impl Default for Codec

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Codec

§

impl RefUnwindSafe for Codec

§

impl Send for Codec

§

impl Sync for Codec

§

impl Unpin for Codec

§

impl UnsafeUnpin for Codec

§

impl UnwindSafe for Codec

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more