Struct FrozenBuffer 

pub struct FrozenBuffer {
    pub inner: Bytes,
}

An immutable buffer for reading bytes data.

The FrozenBuffer struct provides a read-only interface to byte data. Once created, the buffer’s content cannot be modified, but it supports various reading operations including line-by-line reading and copying data to external buffers. It implements Python’s buffer protocol for zero-copy access from Python code.

Examples

from monarch._rust_bindings.monarch_hyperactor.buffers import Buffer

# Create and populate a buffer
buffer = Buffer()
buffer.write(b"Hello\nWorld\n")

# Freeze it for reading
frozen = buffer.freeze()

# Read all content
content = frozen.read()
print(content)  # b"Hello\nWorld\n"

# Read line by line (create a new frozen buffer)
buffer.write(b"Line 1\nLine 2\n")
frozen = buffer.freeze()
line1 = frozen.readline()
line2 = frozen.readline()

Fields

inner: Bytes

Trait Implementations

impl Clone for FrozenBuffer

fn clone(&self) -> FrozenBuffer

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for FrozenBuffer

fn default() -> FrozenBuffer

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FrozenBuffer

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&'static [u8]> for FrozenBuffer

fn from(v: &'static [u8]) -> Self

Converts to this type from the input type.

impl From<FrozenBuffer> for Part

fn from(buf: FrozenBuffer) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for FrozenBuffer

fn from(v: Vec<u8>) -> Self

Converts to this type from the input type.

impl<'py> IntoPyObject<'py> for FrozenBuffer

type Target = FrozenBuffer

The Python output type

type Output = Bound<'py, <FrozenBuffer 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 Named for FrozenBuffer

fn typename() -> &'static str

The globally unique type name for the type. This should typically be the fully qualified Rust name of the type.

fn typehash() -> u64

A globally unique hash for this type. TODO: actually enforce perfect hashing

fn typeid() -> TypeId

The TypeId for this type. TypeIds are unique only within a binary, and should not be used for global identification.

fn port() -> u64

The globally unique port for this type. Typed ports are in the range of 1<<63..1<<64-1.

fn arm(&self) -> Option<&'static str>

If the named type is an enum, this returns the name of the arm of the value self.

unsafe fn arm_unchecked(self_: *const ()) -> Option<&'static str>

An unsafe version of ‘arm’, accepting a pointer to the value, for use in type-erased settings.

impl PartialEq for FrozenBuffer

fn eq(&self, other: &FrozenBuffer) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PyClass for FrozenBuffer

type Frozen = False

Whether the pyclass is frozen.

impl PyClassBaseType for FrozenBuffer

type LayoutAsBase = PyClassObject<FrozenBuffer>

type BaseNativeType = <FrozenBuffer as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<FrozenBuffer>

type PyClassMutability = <FrozenBuffer as PyClassImpl>::PyClassMutability

impl PyClassImpl for FrozenBuffer

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 = /// An immutable buffer for reading bytes data. /// /// The `FrozenBuffer` struct provides a read-only interface to byte data. Once created, /// the buffer's content cannot be modified, but it supports various reading operations /// including line-by-line reading and copying data to external buffers. It implements /// Python's buffer protocol for zero-copy access from Python code. /// /// # Examples /// /// ```python /// from monarch._rust_bindings.monarch_hyperactor.buffers import Buffer /// /// # Create and populate a buffer /// buffer = Buffer() /// buffer.write(b"Hello\nWorld\n") /// /// # Freeze it for reading /// frozen = buffer.freeze() /// /// # Read all content /// content = frozen.read() /// print(content) # b"Hello\nWorld\n" /// /// # Read line by line (create a new frozen buffer) /// buffer.write(b"Line 1\nLine 2\n") /// frozen = buffer.freeze() /// line1 = frozen.readline() /// line2 = frozen.readline() /// ```

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<FrozenBuffer>

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForFrozenBuffer

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<'a, 'holder, 'py> PyFunctionArgument<'a, 'holder, 'py, false> for &'holder FrozenBuffer

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

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 FrozenBuffer

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

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

impl PyTypeInfo for FrozenBuffer

const NAME: &'static str = "FrozenBuffer"

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 Serialize for FrozenBuffer

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl DerefToPyAny for FrozenBuffer

impl StructuralPartialEq for FrozenBuffer