Struct Buffer 

pub struct Buffer { /* private fields */ }

A mutable buffer for reading and writing bytes data.

The Buffer struct provides a hybrid interface for accumulating byte data:

• Small writes (< 256 bytes) are copied into a contiguous buffer to minimize fragment overhead
• Large writes (>= 256 bytes) are stored as zero-copy references to Python bytes objects

This approach balances the overhead of per-fragment processing against the cost of copying data.

Examples

from monarch._rust_bindings.monarch_hyperactor.buffers import Buffer

# Create a new buffer
buffer = Buffer()

# Write some data - small writes are batched, large writes are zero-copy
buffer.write(b"small")  # copied into pending buffer
buffer.write(b"x" * 1000)  # stored as zero-copy reference

Implementations

impl Buffer

pub fn take_part(&mut self) -> Part

Converts accumulated data to Part for zero-copy multipart messages.

Flushes any pending small writes and converts all fragments to bytes::Bytes.

pub fn freeze(&mut self) -> FrozenBuffer

Freezes the buffer, converting it into an immutable FrozenBuffer for reading.

This is the Rust-accessible version of the Python freeze method.

Trait Implementations

impl Clone for Buffer

fn clone(&self) -> Buffer

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for Buffer

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for Buffer

type Target = Buffer

The Python output type

type Output = Bound<'py, <Buffer as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for Buffer

type Frozen = False

Whether the pyclass is frozen.

impl PyClassBaseType for Buffer

type LayoutAsBase = PyClassObject<Buffer>

type BaseNativeType = <Buffer as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<Buffer>

type PyClassMutability = <Buffer as PyClassImpl>::PyClassMutability

impl PyClassImpl for Buffer

const IS_BASETYPE: bool = true

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// A mutable buffer for reading and writing bytes data. /// /// The `Buffer` struct provides a hybrid interface for accumulating byte data: /// - Small writes (< 256 bytes) are copied into a contiguous buffer to minimize fragment overhead /// - Large writes (>= 256 bytes) are stored as zero-copy references to Python bytes objects /// /// This approach balances the overhead of per-fragment processing against the cost of copying data. /// /// # Examples /// /// ```python /// from monarch._rust_bindings.monarch_hyperactor.buffers import Buffer /// /// # Create a new buffer /// buffer = Buffer() /// /// # Write some data - small writes are batched, large writes are zero-copy /// buffer.write(b"small") # copied into pending buffer /// buffer.write(b"x" * 1000) # stored as zero-copy reference /// ```

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<Buffer>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForBuffer

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature for Buffer

const TEXT_SIGNATURE: &'static str = "()"

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder Buffer

type Holder = Option<PyClassGuard<'a, Buffer>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder mut Buffer

type Holder = Option<PyClassGuardMut<'a, Buffer>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'holder mut Self::Holder, ) -> PyResult<Self>

impl PyTypeInfo for Buffer

const NAME: &'static str = "Buffer"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for Buffer