THE ORIONIS API
Build with clarity.
Explore the building blocks of an async-first Python framework. Every module, class, and method — connected, searchable, and ready to build with.
class documentation
Enforce binary access modes while owning a buffered storage payload.
| Method | __init__ |
Own a buffer and apply the driver's validated binary mode. |
| Method | _require |
Reject operations after the buffer has closed. |
| Method | _require |
Reject reads disallowed by the selected mode. |
| Method | _require |
Reject writes disallowed by the selected mode. |
| Method | close |
Close the wrapper and its owned buffer while preserving failures. |
| Method | flush |
Flush the underlying buffer without exposing prohibited reads. |
| Method | read |
Read at most the requested number of bytes. |
| Method | read1 |
Read one logical block from the already buffered payload. |
| Method | readable |
Report whether the selected mode permits reading. |
| Method | readinto |
Read into a writable byte buffer when reading is permitted. |
| Method | readline |
Read one line within the selected mode's permissions. |
| Method | seek |
Move the position without changing append-mode write behavior. |
| Method | seekable |
Report whether the owned buffer supports seeking. |
| Method | tell |
Return the current position of the owned buffer. |
| Method | truncate |
Resize the buffer only when the selected mode permits writing. |
| Method | writable |
Report whether the selected mode permits writing. |
| Method | write |
Write permitted bytes and force append-mode writes to EOF. |
| Class Variable | __slots__ |
Reserve the binary mode and the owned underlying buffer. |
| Instance Variable | _mode |
Store the binary mode controlling the wrapper's I/O permissions. |
| Instance Variable | raw |
Keep the underlying buffer available to persistence callbacks. |
| Property | closed |
Report whether the wrapper or its owned buffer has closed. |
Own a buffer and apply the driver's validated binary mode.
| Parameters | |
raw:typing.BinaryIO | Buffer used by internal persistence callbacks. |
mode:str | Validated binary read, write or append mode. |
| Returns | |
None | No return value. |
Report whether the selected mode permits reading.
| Returns | |
bool | Whether reads are permitted on the open buffer. |
Read into a writable byte buffer when reading is permitted.
| Parameters | |
buffer:bytearray | memoryview | Destination buffer receiving the content. |
| Returns | |
int | Number of bytes copied into the destination. |
Report whether the owned buffer supports seeking.
| Returns | |
bool | Whether the open buffer supports random access. |
Resize the buffer only when the selected mode permits writing.
| Parameters | |
size:int | None | New length, or None to use the current position. |
| Returns | |
int | New buffer length. |
Report whether the selected mode permits writing.
| Returns | |
bool | Whether writes are permitted on the open buffer. |