Struct h2::frame::data::Data

pub struct Data<T = Bytes> {
    stream_id: StreamId,
    data: T,
    flags: DataFlags,
    pad_len: Option<u8>,
}

Data frame

Data frames convey arbitrary, variable-length sequences of octets associated with a stream. One or more DATA frames are used, for instance, to carry HTTP request or response payloads.

Fields

stream_id: StreamId

data: T

flags: DataFlags

pad_len: Option<u8>

Implementations

impl<T> Data<T>

pub fn new(stream_id: StreamId, payload: T) -> Self

Creates a new DATA frame.

pub fn stream_id(&self) -> StreamId

Returns the stream identifier that this frame is associated with.

This cannot be a zero stream identifier.

pub fn is_end_stream(&self) -> bool

Gets the value of the END_STREAM flag for this frame.

If true, this frame is the last that the endpoint will send for the identified stream.

Setting this flag causes the stream to enter one of the “half-closed” states or the “closed” state (Section 5.1).

pub fn set_end_stream(&mut self, val: bool)

Sets the value for the END_STREAM flag on this frame.

pub fn payload(&self) -> &T

Returns a reference to this frame’s payload.

This does not include any padding that might have been originally included.

pub fn payload_mut(&mut self) -> &mut T

Returns a mutable reference to this frame’s payload.

This does not include any padding that might have been originally included.

pub fn into_payload(self) -> T

Consumes self and returns the frame’s payload.

This does not include any padding that might have been originally included.

pub(crate) fn head(&self) -> Head

pub(crate) fn map<F, U>(self, f: F) -> Data<U>

where F: FnOnce(T) -> U,

impl Data<Bytes>

pub(crate) fn load(head: Head, payload: Bytes) -> Result<Self, Error>

impl<T: Buf> Data<T>

pub(crate) fn encode_chunk<U: BufMut>(&mut self, dst: &mut U)

Encode the data frame into the dst buffer.

Panics

Panics if dst cannot contain the data frame.

Trait Implementations

impl<T> Debug for Data<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T> From<Data<T>> for Frame<T>

fn from(src: Data<T>) -> Self

Converts to this type from the input type.

impl<T: PartialEq> PartialEq for Data<T>

fn eq(&self, other: &Data<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Eq> Eq for Data<T>

impl<T> StructuralPartialEq for Data<T>