Struct PyArrowBuffer

pub struct PyArrowBuffer(/* private fields */);

A wrapper around an Arrow Buffer.

This implements both import and export via the Python buffer protocol.

Buffer import

This can be very useful as a general way to support ingest of a Python buffer protocol object. The underlying Arrow Buffer manages the external memory, automatically calling the Python buffer’s release callback when the Arrow Buffer reference count reaches 0.

This does not need to be used with Arrow at all! This can be used with any API where you want to handle both Python-provided and Rust-provided buffers. PyArrowBuffer implements AsRef<[u8]>.

Buffer export

The Python buffer protocol is implemented on this buffer to enable zero-copy data transfer of the core buffer into Python. This allows for zero-copy data sharing with numpy via numpy.frombuffer.

Implementations

impl PyArrowBuffer

pub fn new(buffer: Buffer) -> Self

Construct a new PyArrowBuffer

pub fn into_inner(self) -> Buffer

Consume and return the Buffer

Trait Implementations

impl AsRef<[u8]> for PyArrowBuffer

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<Buffer> for PyArrowBuffer

fn as_ref(&self) -> &Buffer

Converts this type into a shared reference of the (usually inferred) input type.

impl<'py> FromPyObject<'py> for PyArrowBuffer

fn extract_bound(ob: &Bound<'py, PyAny>) -> PyResult<Self>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for PyArrowBuffer

type Target = PyArrowBuffer

The Python output type

type Output = Bound<'py, <PyArrowBuffer 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 PyArrowBuffer

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for PyArrowBuffer

type LayoutAsBase = PyClassObject<PyArrowBuffer>

type BaseNativeType = <PyArrowBuffer as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<PyArrowBuffer>

type PyClassMutability = <PyArrowBuffer as PyClassImpl>::PyClassMutability

impl PyClassImpl for PyArrowBuffer

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)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PyArrowBuffer>

This handles following two situations:

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

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

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

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyClassNewTextSignature<PyArrowBuffer> for PyClassImplCollector<PyArrowBuffer>

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

impl<'a, 'py> PyFunctionArgument<'a, 'py, false> for &'a PyArrowBuffer

type Holder = Option<PyRef<'py, PyArrowBuffer>>

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

impl PyMethods<PyArrowBuffer> for PyClassImplCollector<PyArrowBuffer>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyArrowBuffer

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 PyArrowBuffer