Struct httpbis::solicit::frame::data::DataFrame

pub struct DataFrame {
    pub stream_id: StreamId,
    pub data: Bytes,
    // some fields omitted
}

A struct representing the DATA frames of HTTP/2, as defined in the HTTP/2 spec, section 6.1.

Fields

stream_id: StreamId

The ID of the stream with which the frame is associated.

data: Bytes

The data found in the frame as an opaque byte sequence. It never includes padding bytes.

Methods

impl DataFrame

fn new(stream_id: StreamId) -> DataFrame

Creates a new empty DataFrame, associated to the stream with the given ID.

fn with_data<D: Into<Bytes>>(stream_id: StreamId, data: D) -> DataFrame

Creates a new DataFrame with the given DataChunk.

The chunk can be any type that can be converted into a DataChunk instance and, as such, can either pass ownership of the buffer to the DataFrame or provide a temporary borrow.

fn is_padded(&self) -> bool

Returns true if the DATA frame is padded, otherwise false.

fn is_end_of_stream(&self) -> bool

Returns whther this frame ends the stream it is associated with.

fn set_padding(&mut self, pad_len: u8)

Sets the number of bytes that should be used as padding for this frame.

fn payload_len(&self) -> u32

Returns the total length of the payload, taking into account possible padding.

fn set_flag(&mut self, flag: DataFlag)

Sets the given flag for the frame.

Trait Implementations

impl PartialEq for DataFrame

fn eq(&self, __arg_0: &DataFrame) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, __arg_0: &DataFrame) -> bool

This method tests for !=.

impl Clone for DataFrame

fn clone(&self) -> DataFrame

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for DataFrame

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Frame for DataFrame

type FlagType = DataFlag

The type that represents the flags that the particular Frame can take. This makes sure that only valid Flags are used with each Frame.

fn from_raw(raw_frame: &RawFrame) -> Option<DataFrame>

Creates a new DataFrame from the given RawFrame (i.e. header and payload), if possible. Returns None if a valid DataFrame cannot be constructed from the given RawFrame.

fn is_set(&self, flag: DataFlag) -> bool

Tests if the given flag is set for the frame.

fn get_stream_id(&self) -> StreamId

Returns the StreamId of the stream to which the frame is associated.

fn get_header(&self) -> FrameHeader

Returns a FrameHeader based on the current state of the frame.

impl FrameIR for DataFrame

fn serialize_into<B: FrameBuilder>(self, b: &mut B) -> Result<()>

Write out the on-the-wire representation of the frame into the given FrameBuilder.

fn serialize_into_vec(self) -> Vec<u8> where
    Self: Sized,