Skip to main content

Encoder

Struct Encoder 

Source
pub struct Encoder<T> { /* private fields */ }
Expand description

Encodes JSON records into frame payloads, sharing one DEFLATE window across the log.

The track-free core of Producer. Unlike snapshot::Encoder there are no group boundaries to report: a log is an unbroken sequence of self-contained records, so every payload is simply the next frame.

The window spans everything encoded so far, so payloads must reach the wire in order and be decoded in the same order. If the caller does roll a group, call reset so the next record starts a cold window that the new group’s decoder can follow.

Implementations§

Source§

impl<T> Encoder<T>

Source

pub fn new(config: ProducerConfig) -> Self

Create an encoder with a cold window.

Source

pub fn reset(&mut self)

Start a cold DEFLATE window, for a caller that has just rolled a group.

This is also how a caller clears an Error::Desync: roll a new group so the consumer starts its own cold window, then reset.

Source§

impl<T: Serialize> Encoder<T>

Source

pub fn encode(&mut self, value: &T) -> Result<Pending<'_, T>>

Encode one record into the next frame payload.

The record comes back as a Pending the caller writes and then commits. Errors with Error::Desync if a previous compressed record was left uncommitted, since every frame after it would be undecodable.

Auto Trait Implementations§

§

impl<T> Freeze for Encoder<T>

§

impl<T> RefUnwindSafe for Encoder<T>

§

impl<T> Send for Encoder<T>

§

impl<T> Sync for Encoder<T>

§

impl<T> Unpin for Encoder<T>

§

impl<T> UnsafeUnpin for Encoder<T>

§

impl<T> UnwindSafe for Encoder<T>

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,

Source§

impl<T> MaybeSync for T
where T: Sync,

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

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more