Struct pyo3::types::PyBool

#[repr(transparent)]
pub struct PyBool(_);

Represents a Python bool.

Methods

impl PyBool

pub fn new(py: Python, val: bool) -> &PyBool

Depending on val, returns py.True() or py.False().

pub fn is_true(&self) -> bool

Gets whether this boolean is true.

Trait Implementations

impl AsPyPointer for PyBool

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl ToPyObject for PyBool

fn to_object(&self, py: Python) -> PyObject

Converts self into a Python object.

impl PyNativeType for PyBool

fn py(&self) -> Python

impl PyTypeInfo for PyBool

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

const SIZE: usize

Size of the rust PyObject structure (PyObject + rust structure)

const OFFSET: isize

Type instance offset inside PyObject structure

unsafe fn type_object() -> &'static mut PyTypeObject

PyTypeObject instance for this type, which might still need to be initialized

fn is_instance(ptr: &PyAny) -> bool

Check if *mut ffi::PyObject is instance of this type

const DESCRIPTION: &'static str

Class doc string

const FLAGS: usize

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(object: &PyAny) -> bool

Check if *mut ffi::PyObject is exact instance of this type

impl PyObjectAlloc for PyBool

unsafe fn alloc(_py: Python) -> *mut PyObject

unsafe fn dealloc(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object and frees the memory (usually by calling ptr->ob_type->tp_free). This function is used as tp_dealloc implementation.

unsafe fn drop(py: Python, obj: *mut PyObject)

Calls the rust destructor for the object.

impl PyTypeObject for PyBool

fn init_type() -> NonNull<PyTypeObject>

This function must make sure that the corresponding type object gets initialized exactly once and return it.

fn type_object() -> Py<PyType>

Returns the safe abstraction over the type object from PyTypeObject::init_type

impl AsRef<PyAny> for PyBool

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl PartialEq<PyBool> for PyBool

fn eq(&self, o: &PyBool) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a> From<&'a PyBool> for &'a PyAny

fn from(ob: &'a PyBool) -> Self

Performs the conversion.

impl Display for PyBool

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Debug for PyBool

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.