Module io 

Streaming I/O — file and TCP sources/sinks, byte framing, compression, and std::io bridges.

All operators here speak Vec<u8> chunks and compose with the linear Source/Flow/Sink DSL. The surface is:

• File I/O — synchronous FileIO (on the Datum thread pool) and Tokio-backed TokioFileIO; optional io_uring-backed UringFileIO behind the io-uring-file feature.
• TCP — TokioTcp server (TokioTcp::bind) and client (TokioTcp::outgoing_connection) byte streams. TLS, UDP, and QUIC live in datum-net.
• Framing — Framing: delimiter, length-field, and JSON-object framing.
• Compression — Compression: gzip/gunzip and deflate/inflate, in-process via flate2.
• std::io bridges — StreamConverters adapts blocking std::io::Read/Write to/from Datum streams, and materializes blocking InputStreamHandle/OutputStreamHandle handles.

See io/AGENTS.md for invariants, hot paths, and the Akka mapping.

Structs

Compression

In-process byte-stream (de)compression flows backed by flate2. Mirrors Akka’s Compression.

FileIO

Synchronous, low-overhead file source and sink, backed by StreamConverters over std::fs::File. Mirrors Akka’s FileIO; see super::TokioFileIO for the async variant.

Framing

Byte-stream framing flows: turn a stream of arbitrary Vec<u8> chunks into a stream of complete logical frames. Mirrors Akka’s Framing/JsonFraming.

InputStreamHandle

A blocking std::io::Read handle materialized by StreamConverters::as_input_stream.

IoResult

Akka-style materialized IO result for Tokio-backed file and TCP byte streams.

OutputStreamHandle

A blocking std::io::Write handle materialized by StreamConverters::as_output_stream.

StreamConverters

Bridges between std::io::Read/Write and Datum byte streams. Mirrors Akka’s StreamConverters.

TcpBinding

The bound address of a TCP listener, available as the materialized value of TokioTcp::bind as soon as the listener is bound — before any connection is accepted.

TcpConnection

Address metadata for an established TCP connection, carried as the materialized value of TokioTcp::outgoing_connection and accessible from a TcpIncomingConnection.

TcpIncomingConnection

A TCP connection accepted by TokioTcp::bind.

TokioFileIO

TokioTcp

Enums

FramingByteOrder

Byte order used by Framing::length_field to interpret the length header.

Type Aliases

TokioByteSink

A byte sink whose materialized value resolves to an IoResult (bytes + terminal status).

TokioByteSource

A byte source whose materialized value resolves to an IoResult (bytes + terminal status).