Struct Config 

pub struct Config { /* private fields */ }

Available on crate feature ws only.

Configuration for compio-ws.

API Interface

_with_config functions in this crate accept impl Into<Config>, so following are all valid:

• Config
• WebSocketConfig (use custom WebSocket config with default remaining settings)
• None (use default value)

Implementations

impl Config

pub fn new() -> Config

Creates a new Config with default settings.

pub fn websocket_config(&self) -> Option<&WebSocketConfig>

Get the WebSocket configuration.

pub fn buffer_size_base(&self) -> usize

Get the base buffer size.

pub fn buffer_size_limit(&self) -> usize

Get the maximum buffer size.

pub fn with_buffer_size_base(self, size: usize) -> Config

Set custom base buffer size.

Default to 128 KiB.

pub fn with_buffer_size_limit(self, size: usize) -> Config

Set custom maximum buffer size.

Default to 64 MiB.

pub fn with_buffer_sizes(self, base: usize, limit: usize) -> Config

Set custom buffer sizes.

Default to 128 KiB for base and 64 MiB for limit.

pub fn disable_nagle(self, disable: bool) -> Config

Disable Nagle’s algorithm, i.e. set_nodelay(true).

Default to false. If you don’t know what the Nagle’s algorithm is, better leave it to false.

Trait Implementations

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl From<Option<WebSocketConfig>> for Config

fn from(config: Option<WebSocketConfig>) -> Config

Converts to this type from the input type.

impl From<WebSocketConfig> for Config

fn from(config: WebSocketConfig) -> Config

Converts to this type from the input type.