Struct PyData 

pub struct PyData { /* private fields */ }

Column-major dataset returned from CCDB fetch operations.

Attributes

n_rows : int Number of rows in the dataset. n_columns : int Number of columns in the dataset. column_names : liststr Names for each column in positional order. column_types : listColumnType Storage type for each column in positional order.

Implementations

impl PyData

pub fn n_rows(&self) -> usize

int: Number of rows in the dataset.

pub fn n_columns(&self) -> usize

int: Number of columns in the dataset.

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

liststr: Column names in positional order.

pub fn column_types(&self) -> Vec<PyColumnType>

listColumnType: Column types in positional order.

pub fn column(&self, column: Bound<'_, PyAny>) -> PyResult<PyColumn>

column(self, column)

Parameters

column : int | str Column index or name.

Returns

Column Column wrapper exposing values and metadata.

Raises

RuntimeError If the column cannot be found.

pub fn row(&self, row: usize) -> PyResult<PyRowView>

row(self, row)

Parameters

row : int Zero-based row index.

Returns

RowView Lightweight view over the requested row.

Raises

RuntimeError If the row index is out of range.

pub fn rows(&self) -> PyResult<Vec<PyRowView>>

rows(self)

Returns

list[RowView] View objects for each row in order.

pub fn value( &self, py: Python<'_>, column: Bound<'_, PyAny>, row: usize, ) -> PyResult<Py<PyAny>>

value(self, column, row)

Parameters

column : int | str Column index or name. row : int Zero-based row index.

Returns

object Cell value converted to a Python scalar or None if missing.

Trait Implementations

impl DerefToPyAny for PyData

impl ExtractPyClassWithClone for PyData

impl<'py> IntoPyObject<'py> for PyData

type Target = PyData

The Python output type

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

const NAME: &str = "Data"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyData

const MODULE: Option<&str>

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 = /// Column-major dataset returned from CCDB fetch operations. /// /// Attributes /// ---------- /// n_rows : int /// Number of rows in the dataset. /// n_columns : int /// Number of columns in the dataset. /// column_names : list[str] /// Names for each column in positional order. /// column_types : list[ColumnType] /// Storage type for each column in positional order.

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

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = ThreadCheckerImpl

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 PyMethods<PyData> for PyClassImplCollector<PyData>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyData

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.