Skip to main content

Pending

Struct Pending 

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

An encoded record the caller has not yet acknowledged writing.

Returned by Encoder::encode. Write the payload, then commit.

A frame that is never committed never reached the wire. With compression on that is unrecoverable within the group: the window is ahead of what the consumer holds, and a log has no keyframe to resynchronize on the way snapshot does. So the encoder refuses to encode anything further (Error::Desync) until the caller rolls a new group and calls Encoder::reset. Without compression each record stands alone, so a dropped one leaves a gap in the log but nothing undecodable, and encoding continues.

Implementations§

Source§

impl<T> Pending<'_, T>

Source

pub fn payload(&self) -> &Bytes

The frame payload to write.

Source

pub fn commit(self)

Acknowledge that the record reached the wire, keeping the encoder’s window.

Only call this once the write has actually succeeded.

Trait Implementations§

Source§

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

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

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

Auto Trait Implementations§

§

impl<'a, T> !Freeze for Pending<'a, T>

§

impl<'a, T> !UnwindSafe for Pending<'a, T>

§

impl<'a, T> RefUnwindSafe for Pending<'a, T>

§

impl<'a, T> Send for Pending<'a, T>

§

impl<'a, T> Sync for Pending<'a, T>

§

impl<'a, T> Unpin for Pending<'a, T>

§

impl<'a, T> UnsafeUnpin for Pending<'a, 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