Skip to main content

FrameWriter

Struct FrameWriter 

Source
pub struct FrameWriter {
    pub max_frame_size: usize,
}
Available on crate feature h2 only.
Expand description

Writes frames to an output buffer. The field-block writer (FrameWriter::write_field_block) splits the block across HEADERS/CONTINUATION frames at the peer’s frame-size limit.

Fields§

§max_frame_size: usize

The maximum payload size the peer accepts (the peer’s SETTINGS_MAX_FRAME_SIZE; 16384 by default).

Implementations§

Source§

impl FrameWriter

Source

pub const fn new(max_frame_size: usize) -> FrameWriter

Source

pub fn write_data( &self, out: &mut Vec<u8>, stream_id: u32, end_stream: bool, data: &[u8], )

Source

pub fn write_headers( &self, out: &mut Vec<u8>, stream_id: u32, end_stream: bool, end_headers: bool, priority: Option<Priority>, block: &[u8], )

Writes a HEADERS frame (single frame, no field-block splitting).

Source

pub fn write_field_block( &self, out: &mut Vec<u8>, stream_id: u32, end_stream: bool, block: &[u8], )

Writes a field block as a HEADERS frame (optionally with END_STREAM) followed by as many CONTINUATION frames as needed to stay within the peer’s frame-size limit.

Source

pub fn write_priority( &self, out: &mut Vec<u8>, stream_id: u32, priority: Priority, )

Source

pub fn write_reset(&self, out: &mut Vec<u8>, stream_id: u32, error_code: u32)

Source

pub fn write_settings(&self, out: &mut Vec<u8>, settings: &[Setting])

Source

pub fn write_settings_ack(&self, out: &mut Vec<u8>)

Source

pub fn write_push_promise( &self, out: &mut Vec<u8>, stream_id: u32, promised_stream_id: u32, block: &[u8], )

Source

pub fn write_ping(&self, out: &mut Vec<u8>, payload: &[u8; 8])

Source

pub fn write_ping_ack(&self, out: &mut Vec<u8>, payload: &[u8; 8])

Source

pub fn write_goaway( &self, out: &mut Vec<u8>, last_stream_id: u32, error_code: u32, debug: &[u8], )

Source

pub fn write_window_update( &self, out: &mut Vec<u8>, stream_id: u32, increment: u32, )

Source

pub fn write_continuation( &self, out: &mut Vec<u8>, stream_id: u32, end_headers: bool, block: &[u8], )

Trait Implementations§

Source§

impl Clone for FrameWriter

Source§

fn clone(&self) -> FrameWriter

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for FrameWriter

Source§

impl Debug for FrameWriter

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for FrameWriter

Source§

fn default() -> FrameWriter

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.