Struct Encoder 

pub struct Encoder {
    table: Table,
    max_allowed_size: usize,
    size_update: Option<SizeUpdate>,
    scratch: BytesMut,
}

Fields

table: Table

max_allowed_size: usize

size_update: Option<SizeUpdate>

scratch: BytesMut

Reusable buffer for the encoded header block of a single frame.

A header block only has to live until it is copied into the connection write buffer, so the buffer that holds it can be reused across frames instead of being allocated and freed per frame. See take_scratch / return_scratch.

Implementations

impl Encoder

pub fn new(max_size: usize, capacity: usize) -> Encoder

pub(crate) fn take_scratch(&mut self) -> BytesMut

Takes the reusable buffer for one header-block encode.

The buffer is returned by return_scratch once the encoded block has been copied into the write buffer. If it is not returned - the CONTINUATION path keeps it, since the remainder is still needed - the next call simply starts from a fresh buffer.

pub(crate) fn return_scratch(&mut self, scratch: BytesMut)

Returns a fully-written header block buffer for reuse.

pub fn update_max_size(&mut self, val: usize)

Queues a max size update.

The next call to encode will include a dynamic size update frame.

pub fn encode<I>(&mut self, headers: I, dst: &mut BytesMut)

where I: IntoIterator<Item = Header<Option<HeaderName>>>,

Encode a set of headers into the provide buffer

fn encode_size_updates(&mut self, dst: &mut BytesMut)

fn encode_header(&mut self, index: &Index, dst: &mut BytesMut)

fn encode_header_without_name( &mut self, last: &Index, value: &HeaderValue, dst: &mut BytesMut, )

Trait Implementations

impl Debug for Encoder

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

Formats the value using the given formatter.

impl Default for Encoder

fn default() -> Encoder

Returns the “default value” for a type.