Struct Pending 

pub struct Pending<'a, T> { /* private fields */ }

An encoded frame the caller has not yet acknowledged writing.

Returned by Encoder::update. Read payload and keyframe through the Deref to Encoded, write the frame, then commit.

Dropping it uncommitted Encoder::resets, so a frame that never reached the wire leaves the encoder resynchronizing with a fresh snapshot rather than emitting deltas against a baseline no consumer received. Note that this is a recovery, not a rollback: producing a delta payload advances the group’s DEFLATE window, and that can’t be undone, so a snapshot is the only sound way back. Forgetting to commit a frame that was written is therefore merely wasteful (one redundant snapshot), never incorrect.

Implementations

impl<T> Pending<'_, T>

pub fn commit(self)

Acknowledge that the frame reached the wire, keeping the encoder’s state.

Only call this once the write has actually succeeded. Committing a frame that failed to write is the one thing that corrupts the stream.

Trait Implementations

impl<T> Deref for Pending<'_, T>

type Target = Encoded

The resulting type after dereferencing.

fn deref(&self) -> &Encoded

Dereferences the value.

impl<T> Drop for Pending<'_, T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.