Struct StdioConfig 

pub struct StdioConfig { /* private fields */ }

The settings both halves of the transport are built from.

Cloned into each adapter rather than shared by reference, so a StdioSource and a StdioSink on the same session cannot be pointed at different ceilings after the fact. The value is three words; the invariant is worth more than the copy.

Examples

use protocol_droid::adapters::primary::stdio::StdioConfig;
use protocol_droid::domain::MaxFrameSize;

// The default ceiling, with a smaller read buffer.
let config = StdioConfig::new(MaxFrameSize::new(64 * 1024)?).with_read_chunk(4096);
assert_eq!(config.read_chunk().get(), 4096);

Implementations

impl StdioConfig

pub const fn new(limit: MaxFrameSize) -> Self

The default configuration: a MaxFrameSize::DEFAULT ceiling and a DEFAULT_READ_CHUNK read buffer.

pub const fn with_read_chunk(self, bytes: usize) -> Self

Caps how many bytes one read from the peer’s stream may ask for.

Zero is treated as one byte rather than refused. A zero-length buffer would make read return Ok(0), which every reader in the AsyncRead contract reserves for end-of-stream — so honouring it would silently turn the peer into a closed stream on the first poll. Coercing to one byte keeps the loop making progress and costs nothing but syscalls.

pub const fn limit(self) -> MaxFrameSize

The largest frame this transport will read or write.

pub const fn read_chunk(self) -> NonZeroUsize

How many bytes a single read may ask for.

Trait Implementations

impl Clone for StdioConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for StdioConfig

impl Debug for StdioConfig

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

Formats the value using the given formatter.

impl Default for StdioConfig

fn default() -> Self

The 4 MiB MaxFrameSize::DEFAULT ceiling.

Not a const impl, because Default::default is not a const fn and the project’s rules prefer the trait over a hand-written constructor that only exists to be called from another one.

impl Eq for StdioConfig

impl PartialEq for StdioConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for StdioConfig