Skip to main content

FrameConfig

Struct FrameConfig 

Source
pub struct FrameConfig {
    pub data_frame_payload_size: Option<usize>,
    pub control_write_timeout: Duration,
    pub data_frame_write_timeout: Duration,
    pub read_buffer_size: usize,
    pub write_buffer_size: usize,
    pub max_write_buffer_size: usize,
    pub max_message_size: Option<usize>,
    pub max_frame_size: Option<usize>,
}
Expand description

WebSocket data frame fragmentation, read and write buffers, and receive size limits.

Fields§

§data_frame_payload_size: Option<usize>

Payload size, in bytes, for outgoing data-frame fragments; the default is 32 KiB and None disables active fragmentation. Set to at least 1024 bytes, and the write buffer limit must also accommodate the payload and frame header.

§control_write_timeout: Duration

Maximum time for a single Ping, Pong, or Close write and for closing the underlying sender; the default is 1,500 milliseconds.

§data_frame_write_timeout: Duration

The time limit for writing a single data frame, the default is 1500 milliseconds; it is still subject to the overall message writing deadline.

§read_buffer_size: usize

The underlying WebSocket read buffer size in bytes, default 128 KiB.

§write_buffer_size: usize

Target size of the underlying WebSocket write buffer, in bytes, defaults to 128 KiB; zero is allowed.

§max_write_buffer_size: usize

Maximum number of bytes for the underlying WebSocket write buffer, defaults to 4 MiB; must be larger than the target write buffer size.

§max_message_size: Option<usize>

The maximum number of bytes to receive a complete message, default 64 MiB; None means not to set this size limit.

§max_frame_size: Option<usize>

Maximum bytes in one received frame; the default is 16 MiB and None disables this limit.

Implementations§

Source§

impl FrameConfig

Source

pub const MIN_DATA_FRAME_PAYLOAD_SIZE: usize = 1024

Smallest supported outgoing data-frame payload fragment.

Source

pub const DEFAULT_DATA_FRAME_PAYLOAD_SIZE: usize

Default outgoing data-frame payload fragment size.

Source

pub fn validate(&self) -> Result<()>

Validates frame sizes, buffer capacities, and write deadlines.

Trait Implementations§

Source§

impl Clone for FrameConfig

Source§

fn clone(&self) -> Self

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 Debug for FrameConfig

Source§

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

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

impl Default for FrameConfig

Source§

fn default() -> Self

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more