Skip to main content

Encoder

Struct Encoder 

Source
pub struct Encoder<C = Identity, E = Identity> { /* private fields */ }
Expand description

Synchronous, statically dispatched frame encoder with reusable codec storage.

The caller owns the frame index and must never encrypt different payloads with the same key/index. Use a fresh key for each immutable object. This type performs no I/O, scheduling, implicit indexing, or retries.

Implementations§

Source§

impl<C: CompressionCodec, E: EncryptionCodec> Encoder<C, E>

Source

pub fn new(framing: Framing, compression: C, encryption: E) -> Result<Self>

Create an encoder. Codec types determine the metadata profile.

Source

pub fn config(&self) -> Config

Settings to use when constructing the object’s metadata.

Source

pub fn encode_frame( &mut self, index: u64, buffer: &mut Vec<u8>, ) -> Result<FrameSizes>

Replace raw bytes with stored bytes, returning lengths to append to metadata. Empty/oversized frames and out-of-policy indices are refused. On any error the buffer is cleared, but its allocation is retained.

This does not append metadata: the caller does that after successful I/O. The metadata builder enforces that a short fixed frame is the last frame.

Auto Trait Implementations§

§

impl<C, E> Freeze for Encoder<C, E>
where C: Freeze, E: Freeze,

§

impl<C, E> RefUnwindSafe for Encoder<C, E>

§

impl<C, E> Send for Encoder<C, E>
where C: Send, E: Send,

§

impl<C, E> Sync for Encoder<C, E>
where C: Sync, E: Sync,

§

impl<C, E> Unpin for Encoder<C, E>
where C: Unpin, E: Unpin,

§

impl<C, E> UnsafeUnpin for Encoder<C, E>
where C: UnsafeUnpin, E: UnsafeUnpin,

§

impl<C, E> UnwindSafe for Encoder<C, E>
where C: UnwindSafe, E: UnwindSafe,

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> 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.