Struct PySchema

pub struct PySchema {
    pub schema: SorbetColumnDescriptors,
}

Fields

schema: SorbetColumnDescriptors

Implementations

impl PySchema

The schema representing a set of available columns.

Can be returned by [Recording.schema()][rerun.dataframe.Recording.schema] or [RecordingView.schema()][rerun.dataframe.RecordingView.schema].

fn __iter__(slf: PyRef<'_, Self>) -> PyResult<Py<SchemaIterator>>

Iterate over all the column descriptors in the schema, ignoring RowId.

fn index_columns(&self) -> Vec<PyIndexColumnDescriptor>

Return a list of all the index columns in the schema.

fn component_columns(&self) -> Vec<PyComponentColumnDescriptor>

Return a list of all the component columns in the schema.

fn column_for( &self, entity_path: &str, component: ComponentLike, ) -> Option<PyComponentColumnDescriptor>

Look up the column descriptor for a specific entity path and component.

Parameters

entity_path : str The entity path to look up. component : ComponentLike The component to look up.

Returns

OptionalComponentColumnDescriptor The column descriptor, if it exists.

pub fn column_for_selector( &self, selector: AnyComponentColumn, ) -> PyResult<PyComponentColumnDescriptor>

Look up the column descriptor for a specific selector.

Parameters

selector: str | ComponentColumnDescriptor | ComponentColumnSelector The selector to look up.

String arguments are expected to follow the following format:
`"<entity_path>:<component_name>"`

Returns

ComponentColumnDescriptor The column descriptor, if it exists. Raise an exception otherwise.

impl PySchema

pub fn resolve_component_column_selector( &self, column_selector: &ComponentColumnSelector, ) -> PyResult<PyComponentColumnDescriptor>

Trait Implementations

impl Clone for PySchema

fn clone(&self) -> PySchema

Returns a copy of the value.

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

Performs copy-assignment from source.

impl IntoPy<Py<PyAny>> for PySchema

fn into_py(self, py: Python<'_>) -> PyObject

👎Deprecated since 0.23.0: IntoPy is going to be replaced by IntoPyObject. See the migration guide (https://pyo3.rs/v0.23.0/migration) for more information.

Performs the conversion.

impl<'py> IntoPyObject<'py> for PySchema

type Target = PySchema

The Python output type

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

type Frozen = True

Whether the pyclass is frozen.

impl PyClassImpl for PySchema

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)]

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<PySchema>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::ImmutableChild

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 doc(py: Python<'_>) -> PyResult<&'static CStr>

Rendered class doc

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl<'a, 'py> PyFunctionArgument<'a, 'py> for &'a PySchema

type Holder = Option<PyRef<'py, PySchema>>

fn extract( obj: &'a Bound<'py, PyAny>, holder: &'a mut Self::Holder, ) -> PyResult<Self>

impl PyMethods<PySchema> for PyClassImplCollector<PySchema>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PySchema

const NAME: &'static str = "Schema"

Class name.

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

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 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 PySchema