Skip to main content

Module io

Module io

Expand description

IO streaming utilities.

Modules§

cfg: I/O buffer, timeout, and frame-rate configuration.
testing: In-memory I/O transport and helpers for tests.
types: Values exposed through transport and filter queries.

Macros§

forward_query: Implements Filter::query by forwarding to a field.
forward_ready: Implements Filter::poll_read_ready and Filter::poll_write_ready by forwarding readiness checks to a field.
forward_shutdown: Implements Filter::shutdown by forwarding to a field.

Structs§

Base: Base filter that connects a filter chain to the underlying transport.
Decoded: Result of a single decode attempt.
Dispatcher: Future that dispatches decoded transport frames to a service.
FilterBuf: Buffers and connection state adjacent to one FilterLayer.
FilterCtx: Context used while traversing a complete filter chain.
Flags
Framed: A codec-driven interface to an underlying I/O stream.
Id: Opaque identifier assigned to a registered I/O stream.
Io: Buffered, filterable interface to an underlying I/O stream.
IoBoxed: An Io object whose filter-chain type has been erased.
IoConfig: Shared configuration for an crate::Io stream.
IoContext: Connection context shared with transport read and write tasks.
IoRef: A cheap, cloneable handle to an Io connection.
Layer: One processing layer wrapped around an existing filter chain.
Sealed: Type-erased filter chain used by IoBoxed.
TimerHandle: Handle to an I/O dispatcher timer.
Waiter: A waiter registered for a tag of the I/O stream.

Enums§

Control: Write-side flow-control notification.
DispatchItem: Event delivered to the dispatcher service.
IoStatusUpdate: I/O status update events.
IoTaskStatus: Current status of the I/O state.
Readiness: Filter readiness state.
Reason: Reason a dispatcher is stopping.
RecvError: Errors that can occur while receiving data.

Traits§

Filter: Complete filter-chain interface used by Io.
FilterLayer: A processing layer that transforms an I/O stream’s read and write buffers.
Handle: Control handle for transport-specific I/O tasks.
IoStream: An underlying transport that can be managed by Io.