Struct FrameProducer 

pub struct FrameProducer {
    pub info: Frame,
    /* private fields */
}

Writes a frame’s payload in one or more chunks.

The total bytes written must exactly match Frame::size. Call Self::finish after writing all bytes to verify correctness.

Fields

info: Frame

The frame header containing the expected size.

Implementations

impl FrameProducer

pub fn new(info: Frame) -> Self

Create a new frame producer for the given frame header.

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

Write a chunk of data to the frame.

Returns Error::WrongSize if the total bytes written would exceed Frame::size.

pub fn write_chunk<B: Into<Bytes>>(&mut self, chunk: B) -> Result<()>

👎Deprecated: use write(chunk) instead

Write a chunk of data to the frame.

Deprecated: use Self::write instead.

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

Verify that all bytes have been written.

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

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

Abort the frame with the given error.

pub fn consume(&self) -> FrameConsumer

Create a new consumer for the frame.

pub async fn unused(&self) -> Result<()>

Block until there are no active consumers.

Trait Implementations

impl Clone for FrameProducer

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl From<Frame> for FrameProducer

fn from(info: Frame) -> Self

Converts to this type from the input type.