Skip to main content

Encoder

Struct Encoder 

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

Encodes window edits into frame payloads, deciding where the group boundaries fall.

The track-free core of Producer. It owns the retained window, so it can restate it whenever a group rolls; that restatement is the whole point of the mode, and is what an append-only log cannot do.

Frames must reach the wire in the order they were encoded, and a frame with keyframe set must open a new group: both the positional indices and the group-scoped DEFLATE window depend on it.

Implementations§

Source§

impl<T> Encoder<T>

Source

pub fn new(config: ProducerConfig) -> Self

Create an encoder with an empty window, so the first edit opens a group.

Source

pub fn window(&self) -> Vec<Value>

The retained window, oldest first.

The encoder holds this to restate it on a roll, so a caller needs no parallel copy.

Source

pub fn range(&self) -> Range<u64>

Absolute index of the oldest retained record, and of the next one to be pushed.

Source

pub fn pop(&mut self, count: u64) -> Result<Option<Pending<'_, T>>>

Drop count records from the front of the window.

Returns None when there is nothing to drop, so a caller can trim unconditionally. Emits a pop into the open group, or a header restating what is left in a new group.

Source§

impl<T: Serialize> Encoder<T>

Source

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

Append one record to the back of the window.

Emits a push into the open group, or a header restating the window (the new record included) when the op budget is spent or a frame was lost.

Auto Trait Implementations§

§

impl<T> Freeze for Encoder<T>
where PhantomData<fn(T)>: Freeze,

§

impl<T> RefUnwindSafe for Encoder<T>

§

impl<T> Send for Encoder<T>
where PhantomData<fn(T)>: Send,

§

impl<T> Sync for Encoder<T>
where PhantomData<fn(T)>: Sync,

§

impl<T> Unpin for Encoder<T>
where PhantomData<fn(T)>: Unpin,

§

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> MaybeSend for T
where T: Send + ?Sized,

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 = !

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