Skip to main content

StreamEncoder

Struct StreamEncoder 

Source
pub struct StreamEncoder(/* private fields */);
Expand description

Encoder for one direction of one logical session.

Implementations§

Source§

impl StreamEncoder

Source

pub fn new(encoding: StreamEncoding) -> Result<Self, StreamEncodingError>

Fresh encoder at the default level: deflate 9, zstd 3.

Source

pub fn with_level( encoding: StreamEncoding, level: i32, ) -> Result<Self, StreamEncodingError>

Fresh encoder at a sender-chosen level. The decoder needs only the encoding. Identity ignores the level.

Source

pub fn encode( &mut self, input: &[u8], mode: EncodeMode, output: &mut [u8], ) -> Result<EncodeProgress, StreamEncodingError>

Encode a prefix of input into at most output.len() bytes.

Write takes plaintext, Flush completes all plaintext written so far so the peer can decode it from the wire bytes alone (every batch end), and End writes the end mark, after which the encoder takes nothing more. Callers repeat a step with fresh output room until it is done; a flushing step needs at least ENCODE_MIN_OUTPUT bytes of room.

Source

pub fn is_identity(&self) -> bool

Whether this encoder passes plaintext through unchanged.

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.