Struct PyMapping

#[repr(transparent)]
pub struct PyMapping(PyAny);

Represents a reference to a Python object supporting the mapping protocol.

Values of this type are accessed via PyO3’s smart pointers, e.g. as Py<PyMapping> or Bound<'py, PyMapping>.

For APIs available on mapping objects, see the PyMappingMethods trait which is implemented for Bound<'py, PyMapping>.

Tuple Fields

0: PyAny

Implementations

impl PyMapping

pub fn register<T: PyTypeInfo>(py: Python<'_>) -> PyResult<()>

Register a pyclass as a subclass of collections.abc.Mapping (from the Python standard library). This is equivalent to collections.abc.Mapping.register(T) in Python. This registration is required for a pyclass to be downcastable from PyAny to PyMapping.

Methods from Deref<Target = PyAny>

#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _

Trait Implementations

impl AsRef<PyAny> for PyMapping

fn as_ref(&self) -> &PyAny

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

impl Deref for PyMapping

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyTypeCheck for PyMapping

const NAME: &'static str = "Mapping"

Name of self. This is used in error messages, for example.

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

Checks if object is an instance of Self, which may include a subtype.

impl DerefToPyAny for PyMapping