Struct StructuredArray 

pub struct StructuredArray { /* private fields */ }

A structured array: a flat byte buffer interpreted as n_records records, each described by a StructuredDtype.

Implementations

impl StructuredArray

pub fn new_empty( n_records: usize, field_specs: Vec<(String, String)>, ) -> PyResult<Self>

Construct a zero-initialised structured array.

Arguments

• n_records – number of records to allocate.
• field_specs – list of (name, dtype_str) pairs defining the record layout.

pub fn n_records(&self) -> usize

Return the number of records.

pub fn itemsize(&self) -> usize

Return the byte size of one record.

pub fn get_field_f64(&self, field_name: &str) -> PyResult<Vec<f64>>

Read all values for an f64 field as a Vec<f64>.

Returns PyKeyError if field_name is not found, or PyTypeError if the field dtype is not "f64" / "float64".

pub fn set_field_f64( &mut self, field_name: &str, values: Vec<f64>, ) -> PyResult<()>

Write all values for an f64 field from a Vec<f64>.

Returns PyValueError if values.len() != n_records, PyKeyError if the field is not found, or PyTypeError if the field dtype is not "f64" / "float64".

pub fn field_names(&self) -> Vec<String>

Return the names of all fields.

Trait Implementations

impl DerefToPyAny for StructuredArray

impl ExtractPyClassWithClone for StructuredArray

impl<'py> IntoPyObject<'py> for StructuredArray

type Target = StructuredArray

The Python output type

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

const NAME: &str = "StructuredArray"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for StructuredArray

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[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 structured array: a flat byte buffer interpreted as `n_records` records, /// each described by a [`StructuredDtype`].

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

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>::MutableChild

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 StructuredArray

const TEXT_SIGNATURE: &'static str = "(n_records, field_specs)"

impl PyMethods<StructuredArray> for PyClassImplCollector<StructuredArray>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for StructuredArray

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.