pub struct PyMapping(/* private fields */);Expand description
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>.
Implementations§
Source§impl PyMapping
impl PyMapping
Sourcepub fn register<T: PyTypeInfo>(py: Python<'_>) -> PyResult<()>
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 castable from PyAny to PyMapping.
Trait Implementations§
Source§impl PyTypeInfo for PyMapping
impl PyTypeInfo for PyMapping
Source§const NAME: &'static str = "Mapping"
const NAME: &'static str = "Mapping"
👎Deprecated since 0.28.0: prefer using
::type_object(py).name() to get the correct runtime valueClass name.
Source§const MODULE: Option<&'static str>
const MODULE: Option<&'static str>
👎Deprecated since 0.28.0: prefer using
::type_object(py).module() to get the correct runtime valueModule name, if any.
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn is_type_of(object: &Bound<'_, PyAny>) -> bool
fn is_type_of(object: &Bound<'_, PyAny>) -> bool
Checks if
object is an instance of this type or a subclass of this type.impl DerefToPyAny for PyMapping
Auto Trait Implementations§
impl !Freeze for PyMapping
impl !RefUnwindSafe for PyMapping
impl !Send for PyMapping
impl !Sync for PyMapping
impl Unpin for PyMapping
impl UnwindSafe for PyMapping
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = const NAME: &'static str = T::NAME;
const NAME: &'static str = const NAME: &'static str = T::NAME;
👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.
Source§const TYPE_HINT: TypeHint = const TYPE_HINT: TypeHint = <T as PyTypeInfo>::TYPE_HINT;
const TYPE_HINT: TypeHint = const TYPE_HINT: TypeHint = <T as PyTypeInfo>::TYPE_HINT;
Provides the full python type of the allowed values as a Python type hint.