StreamConfig

Struct StreamConfig 

Source
pub struct StreamConfig {
    pub rx_buf_min_size: usize,
    pub rx_buf_max_size: MaxMessageSizeMultiple,
    pub tx_buf_min_size: usize,
    pub tx_buf_max_size: MaxMessageSizeMultiple,
    pub tx_timeout: Duration,
    pub connect_timeout: Duration,
}
Expand description

Stream related configuration parameters.

Fields§

§rx_buf_min_size: usize

Defines the minimum size of the per-connection receive buffer used for message reassembly. Low values will cause more frequent reallocation while high values will reallocate less at the expense of more memory usage. A buffer never shrinks to less than this value.

§rx_buf_max_size: MaxMessageSizeMultiple

Defines the maximum size of the per-connection receive buffer used for message reassembly. This defaults to Message::MAX_SIZE. This number is very important in DoS mitigation because it prevents a malicious sender from filling up a connection’s receive buffer with endless junk data.

§tx_buf_min_size: usize

Defines the minimum size of the per-connection send buffer. Low values will cause more frequent reallocation while high values will reallocate less at the expense of more memory usage. A buffer never shrinks to less than this value.

§tx_buf_max_size: MaxMessageSizeMultiple

Defines the maximum size of the per-connection send buffer. Once the send buffer is full, it is not possible to queue new messages for sending until some capacity is available. A send buffer becomes full when sending messages faster than the remote peer is reading. This value is important for outbound backpressure control. Defaults to 2 x Message::MAX_SIZE.

§tx_timeout: Duration

The duration after which a peer is disconnected if it fails to read our data.

§connect_timeout: Duration

The duration after which a connect attempt is abandoned. Applies only to non-blocking connect attempts. Blocking ones performed in custom connectors ignore this value.

Trait Implementations§

Source§

impl Clone for StreamConfig

Source§

fn clone(&self) -> StreamConfig

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StreamConfig

Source§

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

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

impl Default for StreamConfig

Source§

fn default() -> Self

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

impl Copy for StreamConfig

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.