Skip to main content

Decoder

Struct Decoder 

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

Decodes a stream’s frame slices back into the original payloads. Hold one per stream; feed slices in frame order (each frame builds on the earlier ones).

Implementations§

Source§

impl Decoder

Source

pub fn new() -> Self

Start a fresh decoder with a cold window and the DEFAULT_MAX_FRAME_SIZE cap.

Source

pub fn with_max_frame_size(max_frame_size: u64) -> Self

Start a fresh decoder with a cold window and a custom per-frame decompressed-size cap.

A malicious or buggy peer could send a tiny slice that inflates hugely, so frame stops and returns Error::TooLarge once a single frame’s output would exceed max_frame_size.

Source

pub fn frame(&mut self, slice: &[u8]) -> Result<Bytes>

Decompress the next frame’s slice back into its payload.

An empty slice yields an empty payload. Returns Error::TooLarge if the frame inflates past the configured cap (checked as output is produced, not from any declared size), and Error::Decompress on malformed input.

Trait Implementations§

Source§

impl Default for Decoder

Source§

fn default() -> Self

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

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> 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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.