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

type Error = PyErr

The type returned in the event of a conversion error.

fn extract(obj: Borrowed<'_, 'py, PyAny>) -> Result<Self, Self::Error>

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

const NAME: &str = "Buffer"

Name of the class.

type Frozen = True

Whether the pyclass is frozen.

impl PyClassBaseType for PyArrowBuffer

type LayoutAsBase = <PyArrowBuffer as PyClassImpl>::Layout

type BaseNativeType = <PyArrowBuffer as PyClassImpl>::BaseNativeType

type Initializer = PyClassInitializer<PyArrowBuffer>

type PyClassMutability = <PyArrowBuffer as PyClassImpl>::PyClassMutability

type Layout<T: PyClassImpl> = <<PyArrowBuffer as PyClassBaseType>::BaseNativeType as PyClassBaseType>::Layout<T>

The type of object layout to use for ancestors or descendants of this type.

impl PyClassImpl for PyArrowBuffer

const MODULE: Option<&str>

Module which the class will be associated with.

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 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`.

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 Layout = <<PyArrowBuffer as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyArrowBuffer>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

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 lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for PyArrowBuffer

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

impl PyMethods<PyArrowBuffer> for PyClassImplCollector<PyArrowBuffer>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyArrowBuffer

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0: prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0: prefer using ::type_object(py).module() to get the correct runtime value

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

impl ExtractPyClassWithClone for PyArrowBuffer