pub struct PyType(/* private fields */);Expand description
Represents a reference to a Python type object.
Values of this type are accessed via PyO3’s smart pointers, e.g. as
Py<PyType> or Bound<'py, PyType>.
For APIs available on type objects, see the PyTypeMethods trait which is implemented for
Bound<'py, PyType>.
Implementations§
Source§impl PyType
impl PyType
Sourcepub unsafe fn from_borrowed_type_ptr(
py: Python<'_>,
p: *mut PyTypeObject,
) -> Bound<'_, PyType>
pub unsafe fn from_borrowed_type_ptr( py: Python<'_>, p: *mut PyTypeObject, ) -> Bound<'_, PyType>
Converts the given FFI pointer into Bound<PyType>, to use in safe code.
The function creates a new reference from the given pointer, and returns
it as a Bound<PyType>.
§Safety
- The pointer must be a valid non-null reference to a
PyTypeObject
Trait Implementations§
Source§impl PyTypeInfo for PyType
impl PyTypeInfo for PyType
Source§const NAME: &'static str = "PyType"
const NAME: &'static str = "PyType"
👎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(obj: &Bound<'_, PyAny>) -> bool
fn is_type_of(obj: &Bound<'_, PyAny>) -> bool
Checks if
object is an instance of this type or a subclass of this type.impl DerefToPyAny for PyType
Auto Trait Implementations§
impl !Freeze for PyType
impl !RefUnwindSafe for PyType
impl !Send for PyType
impl !Sync for PyType
impl Unpin for PyType
impl UnwindSafe for PyType
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.