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>
impl<C: CompressionCodec, E: EncryptionCodec> Encoder<C, E>
Sourcepub fn new(framing: Framing, compression: C, encryption: E) -> Result<Self>
pub fn new(framing: Framing, compression: C, encryption: E) -> Result<Self>
Create an encoder. Codec types determine the metadata profile.
Sourcepub fn encode_frame(
&mut self,
index: u64,
buffer: &mut Vec<u8>,
) -> Result<FrameSizes>
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>
impl<C, E> RefUnwindSafe for Encoder<C, E>where
C: RefUnwindSafe,
E: RefUnwindSafe,
impl<C, E> Send for Encoder<C, E>
impl<C, E> Sync for Encoder<C, E>
impl<C, E> Unpin for Encoder<C, E>
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more