Struct GroupProducer 

pub struct GroupProducer { /* private fields */ }

Writes frames to a group in order.

Each group is delivered independently over a QUIC stream. Use Self::write_frame for simple single-buffer frames, or Self::create_frame for multi-chunk streaming writes.

Implementations

impl GroupProducer

pub fn new(info: Group) -> GroupProducer

Create a new group producer.

pub fn write_frame<B>(&mut self, frame: B) -> Result<(), Error>

where B: Into<Bytes>,

A helper method to write a frame from a single byte buffer.

If you want to write multiple chunks, use Self::create_frame to get a frame producer. But an upfront size is required.

pub fn create_frame(&mut self, info: Frame) -> Result<FrameProducer, Error>

Create a frame with an upfront size

pub fn append_frame(&mut self, frame: FrameProducer) -> Result<(), Error>

Append a frame producer to the group.

pub fn frame_count(&self) -> usize

Return the number of frames written so far.

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

Mark the group as complete; no more frames will be written.

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

Abort the group with the given error.

No updates can be made after this point. Child frames are independent and must be aborted separately if desired; existing frame consumers can still finish reading any frames that were already created.

pub fn consume(&self) -> GroupConsumer

Create a new consumer for the group.

pub async fn closed(&self) -> Error

Block until the group is closed or aborted.

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

Block until there are no active consumers.

Trait Implementations

impl Clone for GroupProducer

fn clone(&self) -> GroupProducer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Deref for GroupProducer

type Target = Group

The resulting type after dereferencing.

fn deref(&self) -> &<GroupProducer as Deref>::Target

Dereferences the value.

impl From<Group> for GroupProducer

fn from(info: Group) -> GroupProducer

Converts to this type from the input type.