Struct PyArrayDescr

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

Binding of numpy.dtype.

Example

use numpy::{dtype, get_array_module, PyArrayDescr, PyArrayDescrMethods};
use numpy::pyo3::{types::{IntoPyDict, PyAnyMethods}, Python, ffi::c_str};

Python::with_gil(|py| {
    let locals = [("np", get_array_module(py)?)].into_py_dict(py)?;

    let dt = py
        .eval(c_str!("np.array([1, 2, 3.0]).dtype"), Some(&locals), None)?
        .downcast_into::<PyArrayDescr>()?;

    assert!(dt.is_equiv_to(&dtype::<f64>(py)));
})

Implementations

impl PyArrayDescr

pub fn new<'a, 'py, T>(py: Python<'py>, ob: T) -> PyResult<Bound<'py, Self>>

where T: IntoPyObject<'py>,

Creates a new type descriptor (“dtype”) object from an arbitrary object.

Equivalent to invoking the constructor of numpy.dtype.

pub fn new_bound<'py, T: ToPyObject + ?Sized>( py: Python<'py>, ob: &T, ) -> PyResult<Bound<'py, Self>>

👎Deprecated since 0.23.0: renamed to PyArrayDescr::new

Deprecated name for PyArrayDescr::new.

pub fn object(py: Python<'_>) -> Bound<'_, Self>

Shortcut for creating a type descriptor of object type.

pub fn object_bound(py: Python<'_>) -> Bound<'_, Self>

👎Deprecated since 0.23.0: renamed to PyArrayDescr::object

Deprecated name for PyArrayDescr::object.

pub fn of<'py, T: Element>(py: Python<'py>) -> Bound<'py, Self>

Returns the type descriptor for a registered type.

pub fn of_bound<'py, T: Element>(py: Python<'py>) -> Bound<'py, Self>

👎Deprecated since 0.23.0: renamed to PyArrayDescr::of

Deprecated name for PyArrayDescr::of.

Trait Implementations

impl AsRef<PyAny> for PyArrayDescr

fn as_ref(&self) -> &PyAny

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

impl Deref for PyArrayDescr

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyTypeInfo for PyArrayDescr

const NAME: &'static str = "PyArrayDescr"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw<'py>(py: Python<'py>) -> *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 type_object_bound(py: Python<'_>) -> Bound<'_, PyType>

👎Deprecated since 0.23.0: renamed to PyTypeInfo::type_object

Deprecated name for PyTypeInfo::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_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

fn is_exact_type_of_bound(object: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_exact_type_of

Deprecated name for PyTypeInfo::is_exact_type_of.

impl DerefToPyAny for PyArrayDescr