Struct LimitsBuilder 

pub struct LimitsBuilder { /* private fields */ }

Builds Limits; every setter is optional.

use net_io::{ConfigReason, Limits, NetError};
let err = Limits::builder().max_connections(100).max_per_listener(200).build().unwrap_err();
assert!(matches!(err, NetError::InvalidConfig { field: "max_per_listener", reason: ConfigReason::AboveGlobal }));
assert!(Limits::builder().max_connections(100).build().is_ok());

Implementations

impl LimitsBuilder

pub fn max_connections(self, value: u32) -> Self

The global connection cap.

pub fn max_per_listener(self, value: u32) -> Self

The per-listener connection cap.

pub fn backlog(self, value: u32) -> Self

The listen backlog.

pub fn accept_batch(self, value: u16) -> Self

Connections accepted per wake-up.

pub fn handshake_timeout(self, value: Duration) -> Self

Time for the PROXY header and TLS handshake together.

pub fn idle_timeout(self, value: Duration) -> Self

Time to wait for the next exchange.

pub fn read_timeout(self, value: Duration) -> Self

Time to wait for bytes during an exchange.

pub fn write_timeout(self, value: Duration) -> Self

Time to wait for the peer to take bytes.

pub fn park_timeout(self, value: Duration) -> Self

Time a parked connection may wait for its completion.

pub fn min_rate(self, value: MinRate) -> Self

The minimum transfer rate (MinRate::off to disable).

pub fn output_budget(self, value: u32) -> Self

Pool memory a connection’s output may hold.

pub fn buffer_budget(self, value: u64) -> Self

Total bytes of buffers all workers may allocate.

pub fn drain_timeout(self, value: Duration) -> Self

The drain deadline.

pub fn refusal_bytes_max(self, value: u16) -> Self

The largest refusal reply (at most 512).

pub fn tick(self, value: Duration) -> Self

The timer resolution (1 ms to 100 ms).

pub fn pressure(self, value: Pressure) -> Self

Adaptive deadlines under pressure (applied from 0.6.0).

pub fn max_per_source(self, n: u32, policy: PrefixPolicy) -> Self

The per-source concurrency cap and how sources are grouped.

pub fn proxy_header_max(self, v2_body_bytes: u16) -> Self

The PROXY v2 address-and-TLV cap (up to 65,519).

pub fn read_class(self, initial: SizeClass, max: SizeClass) -> Self

The initial read buffer class and the largest a session may grow it to.

pub fn completion_queue(self, n: u32) -> Self

A worker’s completion queue length, rounded up to a power of two.

pub fn graceful_linger(self, time: Duration, bytes: u32) -> Self

The graceful-close linger: time and bytes read and discarded.

pub fn lane_reserve(self, lane: Lane, slots: u32) -> Self

Connection slots reserved for lane (lanes 0 to 7; applied from 0.6.0).

pub fn build(self) -> Result<Limits, NetError>

Checks the values that were set and returns the limits.

Errors

InvalidConfig { field, reason } for the first rule broken, in the order documented in docs/API.md.

Trait Implementations

impl Clone for LimitsBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LimitsBuilder

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

Formats the value using the given formatter.

impl Default for LimitsBuilder

fn default() -> Self

Returns the “default value” for a type.