API Reference — `trio`

24 entries across 7 modules.

By Task

Concrete stream types for files, memory, and memory-mapped files with full I/O capabilities

API	Module	Summary
BoundedIOStream	Stream	Base interface for a fully-featured, finite-size I/O stream — one type that can be opened/closed, read, written, seeked, and sized.
FileStream	FileStream	Standard file stream implementation — read from or write to a file on disk through the `BoundedIOStream` interface.
MemoryMappedFileStream	MemoryMappedFileStream	Memory mapped file stream. Use this when you need direct memory access to file contents instead of buffered read/write calls.
MemoryStream	MemoryStream	In-memory stream. Use this when you need a `BoundedIOStream`-compatible buffer that isn't backed by a file, for example to stage serialized data before writing it out.

Abstract interfaces defining individual read, write, seek, and size operations on streams

API	Module	Summary
Bounded	Concepts	Abstract interface for streams that have a known, finite size in bytes.
Readable	Concepts	Abstract interface for anything bytes can be read from — into a buffer or into another stream.
Resizable	Concepts	Abstract interface for streams whose underlying storage can be resized to an exact byte length.
Seekable	Concepts	Abstract interface for streams that support random access via a position cursor.
Writable	Concepts	Abstract interface for anything bytes can be written to — a byte buffer or another stream.

Interfaces and utilities for opening, closing, and managing stream resource lifecycles

API	Module	Summary
Closeable	Concepts	Abstract interface for streams that must release an underlying resource when done.
Controllable	Concepts	Combines `Openable` and `Closeable` into a single interface for streams whose lifecycle needs both an explicit open and close step.
Openable	Concepts	Abstract interface for streams that must be explicitly opened before use.
StreamScope	StreamScope	RAII wrapper that opens a `Controllable` stream on construction and closes it on destruction.

Parameters and enumerations controlling how streams are opened and the data format they use

API	Module	Summary
AccessMode	Stream	Alias, scoped under `BoundedIOStream`, for `trio::AccessMode` — controls whether a stream is opened for reading or writing.
AccessMode	Parameters	Enumerates how a stream is opened: for reading, writing, or both.
OpenMode	Stream	Alias, scoped under `BoundedIOStream`, for `trio::OpenMode` — controls whether a stream is opened in binary or textual mode.
OpenMode	Parameters	Enumerates the byte-level mode a stream is opened in: binary or text.

Buffered stream behavior and factory-based creation and destruction for stream instances

API	Module	Summary
Buffered	Concepts	Abstract interface for streams that buffer writes and need an explicit flush to guarantee data reaches the filesystem.
DefaultInstanceCreator	FileStream	Specialization telling `pma`'s generic factory machinery how to create a `trio::FileStream` instance by default.
DefaultInstanceCreator	MemoryMappedFileStream	Template specialization that binds `trio::MemoryMappedFileStream` to its factory-based creation function.
DefaultInstanceCreator	MemoryStream	Template specialization that binds `trio::MemoryStream` to its factory-based creation function.
DefaultInstanceDestroyer	FileStream	Template specialization that binds `trio::FileStream` to its factory-based destruction function.
DefaultInstanceDestroyer	MemoryMappedFileStream	Template specialization that binds `trio::MemoryMappedFileStream` to its factory-based destruction function.
DefaultInstanceDestroyer	MemoryStream	Template specialization that binds `trio::MemoryStream` to its factory-based destruction function.

Module	File	Entries
Concepts	Concepts.md	9
Stream	Stream.md	3
FileStream	streams/FileStream.md	3
MemoryMappedFileStream	streams/MemoryMappedFileStream.md	3
MemoryStream	streams/MemoryStream.md	3
Parameters	types/Parameters.md	2
StreamScope	utils/StreamScope.md	1