Struct cpython::PyNone

pub struct PyNone;

An empty struct that represents None in Python.

This can be used as a function return type for functions that should return None in Python.

Example

use cpython::{Python, PyResult, PyNone};

fn example(py: Python) -> PyResult<PyNone> {
   Ok(PyNone)
}

Trait Implementations

impl Clone for PyNone

fn clone(&self) -> PyNone

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for PyNone

impl Debug for PyNone

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

Formats the value using the given formatter.

impl Default for PyNone

fn default() -> PyNone

Returns the "default value" for a type.

impl Eq for PyNone

impl FromPyObject<'_> for PyNone

fn extract(py: Python<'_>, obj: &PyObject) -> PyResult<Self>

Extracts Self from the source PyObject.

impl Hash for PyNone

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for PyNone

fn cmp(&self, other: &PyNone) -> Ordering

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<PyNone> for PyNone

fn eq(&self, other: &PyNone) -> bool

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

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

This method tests for !=.

impl PartialOrd<PyNone> for PyNone

fn partial_cmp(&self, other: &PyNone) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for PyNone

impl StructuralPartialEq for PyNone

impl ToPyObject for PyNone

type ObjectType = PyObject

fn to_py_object(&self, py: Python<'_>) -> PyObject

Converts self into a Python object.

fn into_py_object(self, py: Python<'_>) -> Self::ObjectType where
    Self: Sized, 

Converts self into a Python object.

fn with_borrowed_ptr<F, R>(&self, py: Python<'_>, f: F) -> R where
    F: FnOnce(*mut PyObject) -> R, 

Converts self into a Python object and calls the specified closure on the native FFI pointer underlying the Python object.