Trait StreamDataControl

pub trait StreamDataControl {
    const TYPE: StreamType;

    // Required methods
    fn data_size(&self) -> usize;
    fn end_of_stream(&self) -> bool;

    // Provided methods
    fn all(&self) -> Option<Vec<u8>> { ... }
    fn get(&self, range: impl RangeBounds<usize>) -> Option<Vec<u8>> { ... }
    fn set(&self, range: impl RangeBounds<usize>, value: &[u8]) { ... }
    fn replace(&self, value: &[u8]) { ... }
    fn clear(&self) { ... }
    fn write_upstream(&self, data: &[u8]) { ... }
    fn write_downstream(&self, data: &[u8]) { ... }
}

Defines functions to interact with stream data

Required Associated Constants

const TYPE: StreamType

Upstream or Downstream

Required Methods

fn data_size(&self) -> usize

Length of this chunk of data

fn end_of_stream(&self) -> bool

If true, this will be the last downstream data for this context.

Provided Methods

fn all(&self) -> Option<Vec<u8>>

Get all data

fn get(&self, range: impl RangeBounds<usize>) -> Option<Vec<u8>>

Get a range of data

fn set(&self, range: impl RangeBounds<usize>, value: &[u8])

Replace a range of data with value.

fn replace(&self, value: &[u8])

Replace the entire data with value

fn clear(&self)

Clear the data

fn write_upstream(&self, data: &[u8])

Writes data directly upstream, should be called from downstream context.

fn write_downstream(&self, data: &[u8])

Writes data directly downstream, should be called from upstream context.

Dyn Compatibility

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Implementors

impl StreamDataControl for DownstreamData

const TYPE: StreamType = StreamType::Downstream

impl StreamDataControl for UpstreamData

const TYPE: StreamType = StreamType::Upstream