Skip to main content

Producer

Struct Producer 

Source
pub struct Producer<'a> { /* private fields */ }
Expand description

Writes the payload of the single in-flight frame in one or more chunks.

Borrows the parent group::Producer exclusively, so no other frame can be opened while this one is live. The total bytes written must exactly match Info::size; call Self::finish to commit the frame (or Self::abort to fail it). Dropping without either aborts the group, since an unfinished frame leaves the group’s stream broken.

A single whole-frame write keeps the caller’s allocation (zero-copy); chunked writes copy into one buffer sized to the declared frame.

Implementations§

Source§

impl<'a> Producer<'a>

Source

pub fn group(&self) -> Info

The parent group this frame belongs to.

Source

pub fn remaining(&self) -> usize

Bytes still needed to complete the frame.

Source

pub fn write<B: IntoBytes>(&mut self, chunk: B) -> Result<()>

Write a chunk of data to the frame.

Returns Error::WrongSize if the chunk would exceed the remaining bytes.

Source

pub fn finish(self) -> Result<()>

Commit the frame, verifying that all bytes were written.

Returns Error::WrongSize if the bytes written don’t match Info::size.

Source

pub fn abort(self, err: Error) -> Result<()>

Abort the frame (and its group) with the given error.

Trait Implementations§

Source§

impl Deref for Producer<'_>

Source§

type Target = Info

The resulting type after dereferencing.
Source§

fn deref(&self) -> &Self::Target

Dereferences the value.
Source§

impl Drop for Producer<'_>

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> !UnwindSafe for Producer<'a>

§

impl<'a> Freeze for Producer<'a>

§

impl<'a> RefUnwindSafe for Producer<'a>

§

impl<'a> Send for Producer<'a>

§

impl<'a> Sync for Producer<'a>

§

impl<'a> Unpin for Producer<'a>

§

impl<'a> UnsafeUnpin for Producer<'a>

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<P, T> Receiver for P
where P: Deref<Target = T> + ?Sized, T: ?Sized,

Source§

type Target = T

🔬This is a nightly-only experimental API. (arbitrary_self_types)
The target type on which the method may be called.
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, !>

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