Struct PyBool

pub struct PyBool(/* private fields */);

Represents a Python bool.

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

For APIs available on bool objects, see the PyBoolMethods trait which is implemented for Bound<'py, PyBool>.

Implementations

impl PyBool

pub fn new(py: Python<'_>, val: bool) -> Borrowed<'_, '_, Self>

Depending on val, returns true or false.

Note

This returns a Borrowed reference to one of Pythons True or False singletons

pub fn new_bound(py: Python<'_>, val: bool) -> Borrowed<'_, '_, Self>

👎Deprecated since 0.23.0: renamed to PyBool::new

Deprecated name for PyBool::new.

Trait Implementations

impl AsRef<PyAny> for PyBool

fn as_ref(&self) -> &PyAny

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

impl Deref for PyBool

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny

Dereferences the value.

impl PyTypeInfo for PyBool

const NAME: &'static str = "PyBool"

Class name.

const MODULE: Option<&'static str>

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn is_type_of_bound(obj: &Bound<'_, PyAny>) -> bool

👎Deprecated since 0.23.0: renamed to PyTypeInfo::is_type_of

Deprecated name for PyTypeInfo::is_type_of.

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_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 PyBool

impl PyLayout<PyBool> for PyObject

impl PySizedLayout<PyBool> for PyObject