Struct yamux::Config

source ·
pub struct Config { /* private fields */ }
Expand description

Yamux configuration.

The default configuration values are as follows:

  • receive window = 256 KiB
  • max. buffer size (per stream) = 1 MiB
  • max. number of streams = 8192
  • window update mode = on read
  • read after close = true
  • split send size = 16 KiB

Implementations§

source§

impl Config

source

pub fn set_receive_window(&mut self, n: u32) -> &mut Self

Set the receive window per stream (must be >= 256 KiB).

Panics

If the given receive window is < 256 KiB.

source

pub fn set_max_buffer_size(&mut self, n: usize) -> &mut Self

Set the max. buffer size per stream.

source

pub fn set_max_num_streams(&mut self, n: usize) -> &mut Self

Set the max. number of streams.

source

pub fn set_window_update_mode(&mut self, m: WindowUpdateMode) -> &mut Self

Set the window update mode to use.

source

pub fn set_read_after_close(&mut self, b: bool) -> &mut Self

Allow or disallow streams to read from buffered data after the connection has been closed.

source

pub fn set_split_send_size(&mut self, n: usize) -> &mut Self

Set the max. payload size used when sending data frames. Payloads larger than the configured max. will be split.

Trait Implementations§

source§

impl Clone for Config

source§

fn clone(&self) -> Config

Returns a copy 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 Config

source§

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

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

impl Default for Config

source§

fn default() -> Self

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

Auto Trait Implementations§

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

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

source§

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

Mutably borrows from an owned value. 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 Twhere 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 Twhere T: Clone,

§

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 Twhere U: Into<T>,

§

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 Twhere U: TryFrom<T>,

§

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<V, T> VZip<V> for Twhere V: MultiLane<T>,

source§

fn vzip(self) -> V