Enum AnyBufferProtocol 

pub enum AnyBufferProtocol {
    UInt8(PyBuffer<u8>),
    UInt16(PyBuffer<u16>),
    UInt32(PyBuffer<u32>),
    UInt64(PyBuffer<u64>),
    Int8(PyBuffer<i8>),
    Int16(PyBuffer<i16>),
    Int32(PyBuffer<i32>),
    Int64(PyBuffer<i64>),
    Float32(PyBuffer<f32>),
    Float64(PyBuffer<f64>),
}

An enum over buffer protocol input types.

Variants

UInt8(PyBuffer<u8>)

UInt16(PyBuffer<u16>)

UInt32(PyBuffer<u32>)

UInt64(PyBuffer<u64>)

Int8(PyBuffer<i8>)

Int16(PyBuffer<i16>)

Int32(PyBuffer<i32>)

Int64(PyBuffer<i64>)

Float32(PyBuffer<f32>)

Float64(PyBuffer<f64>)

Implementations

impl AnyBufferProtocol

pub fn into_arrow_array(self) -> PyArrowResult<ArrayRef>

Consume this and convert to an Arrow ArrayRef.

For almost all buffer protocol objects this is zero-copy. Only boolean-typed buffers need to be copied, because boolean Python buffers are one byte per element, while Arrow buffers are one bit per element. All numeric buffers are zero-copy compatible.

This uses Buffer::from_custom_allocation, which creates Arrow buffers from existing memory regions. The Buffer tracks ownership of the PyBuffer memory via reference counting. The PyBuffer’s release callback will be called when the Arrow Buffer sees that the PyBuffer’s reference count reaches zero.

Safety

• This assumes that the Python buffer is immutable. Immutability is not guaranteed by the Python buffer protocol, so the end user must uphold this. Mutating a Python buffer could lead to undefined behavior.

pub fn into_arrow_buffer(self) -> PyArrowResult<Buffer>

Consume this buffer protocol object and convert to an Arrow Buffer.

Trait Implementations

impl Debug for AnyBufferProtocol

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'py> FromPyObject<'py> for AnyBufferProtocol

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

Extracts Self from the bound smart pointer obj.

impl TryFrom<AnyBufferProtocol> for PyArray

type Error = PyArrowError

The type returned in the event of a conversion error.

fn try_from(value: AnyBufferProtocol) -> Result<Self, Self::Error>

Performs the conversion.