Skip to main content

PyArray

minarrow_pyo3::types

Struct PyArray

#[repr(transparent)]
pub struct PyArray(pub FieldArray);

Expand description

Transparent wrapper around MinArrow’s FieldArray.

Enables zero-copy conversion to/from PyArrow arrays via the Arrow C Data Interface. Preserves exact Arrow type metadata (e.g., Timestamp vs Date64) through the conversion.

§Example (Rust)

use minarrow_pyo3::PyArray;
use minarrow::FieldArray;

#[pyfunction]
fn process_array(arr: PyArray) -> PyResult<PyArray> {
    let field_array: FieldArray = arr.into();
    // Process...
    Ok(PyArray::from(field_array))
}

Tuple Fields§

§0: FieldArray

Implementations§

impl PyArray

pub fn new(field_array: FieldArray) -> Self

Creates a new PyArray from a FieldArray.

pub fn inner(&self) -> &Array

Returns a reference to the inner MinArrow Array.

pub fn field_array(&self) -> &FieldArray

Returns a reference to the inner MinArrow FieldArray.

pub fn field(&self) -> &Field

Returns a reference to the Field metadata.

pub fn into_inner(self) -> FieldArray

Consumes self and returns the inner FieldArray.

Trait Implementations§

impl AsRef<Array> for PyArray

fn as_ref(&self) -> &Array

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

impl Clone for PyArray

fn clone(&self) -> PyArray

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl Debug for PyArray

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

Formats the value using the given formatter. Read more

impl From<Arc<Array>> for PyArray

fn from(array: Arc<Array>) -> Self

Converts to this type from the input type.

impl From<Array> for PyArray

fn from(array: Array) -> Self

Converts to this type from the input type.

impl From<FieldArray> for PyArray

fn from(field_array: FieldArray) -> Self

Converts to this type from the input type.

impl From<PyArray> for Arc<Array>

fn from(value: PyArray) -> Self

Converts to this type from the input type.

impl From<PyArray> for FieldArray

fn from(value: PyArray) -> Self

Converts to this type from the input type.

impl<'py> FromPyObject<'py> for PyArray

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

Extracts Self from the bound smart pointer obj. Read more

impl<'py> IntoPyObject<'py> for PyArray

type Target = PyAny

The Python output type

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

The smart pointer type to use. Read more

type Error = PyErr

The type returned in the event of a conversion error.

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

Performs the conversion.

Auto Trait Implementations§

impl Freeze for PyArray

impl RefUnwindSafe for PyArray

impl Send for PyArray

impl Sync for PyArray

impl Unpin for PyArray

impl UnsafeUnpin for PyArray

impl UnwindSafe for PyArray

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<'py, T> FromPyObjectBound<'_, 'py> for T
where T: FromPyObject<'py>,

fn from_py_object_bound(ob: Borrowed<'_, 'py, PyAny>) -> Result<T, PyErr>

Extracts Self from the bound smart pointer obj. Read more

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<'py, T> IntoPyObjectExt<'py> for T
where T: IntoPyObject<'py>,

fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>

Converts self into an owned Python object, dropping type information.

fn into_py_any(self, py: Python<'py>) -> Result<Py<PyAny>, PyErr>

Converts self into an owned Python object, dropping type information and unbinding it from the 'py lifetime.

fn into_pyobject_or_pyerr(self, py: Python<'py>) -> Result<Self::Output, PyErr>

Converts self into a Python object. Read more

impl<T> PyErrArguments for T
where T: for<'py> IntoPyObject<'py> + Send + Sync,

fn arguments(self, py: Python<'_>) -> Py<PyAny>

Arguments for exception

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<T> Ungil for T
where T: Send,