ORIONIS API REFERENCE

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.

Explore modules View classes

orionis.http.payload.contracts.body_stream.IBodyStream

class documentation

class IBodyStream(ABC): (source)

Known subclasses: orionis.http.payload.body.BodyStream

View In Hierarchy

Define the minimal contract for reading an HTTP request body.

Notes

Both stream() and read() must be safe to call multiple times once the body has been fully buffered.

Async Method read Buffer and return the full request body. Idempotent.
Async Method stream Yield successive byte chunks from the request body.
Class Variable __slots__ Undocumented
Property isBuffered Return True when the full body has been cached by read().
Property isConsumed Return True when the raw transport stream has been consumed.
async def read(self) -> bytes: (source)
overridden in orionis.http.payload.body.BodyStream

Buffer and return the full request body. Idempotent.

Implementations must cache the result so repeated calls return the same bytes object without re-reading the transport.

Returns
bytesComplete body as a contiguous bytes object.
async def stream(self) -> AsyncGenerator[bytes]: (source)
overridden in orionis.http.payload.body.BodyStream

Yield successive byte chunks from the request body.

Implementations must replay from the internal buffer when read() was called first, so streaming consumers (e.g. multipart parsers) still work after a plain body() call.

Yields
bytesA chunk of the raw request body.
Raises
RuntimeErrorIf the stream was consumed by a streaming consumer before the body was buffered.
PayloadTooLargeExceptionIf incoming data exceeds the configured body-size limit.
__slots__: tuple = (source)
overridden in orionis.http.payload.body.BodyStream

Undocumented

isBuffered: bool = (source)
overridden in orionis.http.payload.body.BodyStream

Return True when the full body has been cached by read().

Returns
boolTrue if the body has been fully buffered, False otherwise.
isConsumed: bool = (source)
overridden in orionis.http.payload.body.BodyStream

Return True when the raw transport stream has been consumed.

Returns
boolTrue if the transport stream has been iterated, False otherwise.