Struct Config

pub struct Config {
    pub version: u8,
    pub keep_alive_interval: Duration,
    pub keep_alive_timeout: Duration,
    pub max_frame_size: usize,
    pub max_receive_buffer: usize,
    pub max_stream_buffer: usize,
    pub enable_keep_alive: bool,
}

Configuration for a smux session.

Config contains all the tunable parameters for a smux session, including keep-alive settings, buffer sizes, and protocol version.

Examples

Using default configuration

use smux::Config;

let config = Config::default();
assert_eq!(config.version, 1);
assert!(config.enable_keep_alive);

Creating custom configuration

use smux::{Config, ConfigBuilder};
use std::time::Duration;

let config = ConfigBuilder::new()
    .version(2)
    .keep_alive_interval(Duration::from_secs(30))
    .max_frame_size(64 * 1024)
    .build()
    .expect("Valid configuration");

Fields

version: u8

keep_alive_interval: Duration

keep_alive_timeout: Duration

max_frame_size: usize

max_receive_buffer: usize

max_stream_buffer: usize

enable_keep_alive: bool

Implementations

impl Config

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

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.