Struct pyo3::types::typeobject::PyType
source · #[repr(transparent)]pub struct PyType(PyAny);
Expand description
Represents a reference to a Python type object
.
Tuple Fields§
§0: PyAny
Implementations§
source§impl PyType
impl PyType
sourcepub fn new_bound<T: PyTypeInfo>(py: Python<'_>) -> Bound<'_, PyType>
pub fn new_bound<T: PyTypeInfo>(py: Python<'_>) -> Bound<'_, PyType>
Creates a new type object.
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
Methods from Deref<Target = PyAny>§
#[doc(hidden)] pub const _PYO3_DEF: AddTypeToModule<Self> = _
Trait Implementations§
source§impl AsPyPointer for PyType
impl AsPyPointer for PyType
source§impl PyTypeInfo for PyType
impl PyTypeInfo for PyType
source§const MODULE: Option<&'static str> = _
const MODULE: Option<&'static str> = _
Available on non-crate feature
gil-refs
only.Module name, if any.
source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Available on non-crate feature
gil-refs
only.Returns the PyTypeObject instance for this type.
source§fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool
fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool
Available on non-crate feature
gil-refs
only.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> AssertNotZeroSized for T
impl<T> AssertNotZeroSized for T
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 more