Struct cpython::PySet

pub struct PySet(_);

Represents a Python set.

Implementations

impl PySet

pub fn new<I>(py: Python<'_>, iterable: I) -> PyResult<PySet>where
    I: ToPyObject,

Creates a new set from any iterable

Corresponds to set(iterable) in Python.

pub fn empty(py: Python<'_>) -> PyResult<PySet>

Creates an empty set

Corresponds to set() in Python

pub fn clear(&self, py: Python<'_>) -> PyResult<()>

Empty an existing set of all values.

pub fn len(&self, _py: Python<'_>) -> usize

Return the number of items in the set This is equivalent to Python len(self)

pub fn contains<V>(&self, py: Python<'_>, value: V) -> PyResult<bool>where
    V: ToPyObject,

Determine if the set contains the specified value. This is equivalent to the Python expression value in self.

pub fn add<V>(&self, py: Python<'_>, value: V) -> PyResult<()>where
    V: ToPyObject,

Add a value. This is equivalent to the Python expression self.add(value).

pub fn discard<V>(&self, py: Python<'_>, value: V) -> PyResult<()>where
    V: ToPyObject,

Discard a value This is equivalent to the Python expression self.discard(value).

pub fn pop(&self, py: Python<'_>) -> PyResult<PyObject>

Pop a value This is equivalent to the Python expression self.pop(value). We get KeyError if the set is empty

Trait Implementations

impl<'s> FromPyObject<'s> for &'s PySet

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

Extracts Self from the source PyObject.

impl<'s> FromPyObject<'s> for PySet

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

Extracts Self from the source PyObject.

impl PythonObject for PySet

unsafe fn unchecked_downcast_from(obj: PyObject) -> Self

Unchecked downcast from PyObject to Self. Undefined behavior if the input object does not have the expected type.

unsafe fn unchecked_downcast_borrow_from<'a>(obj: &'a PyObject) -> &'a Self

Unchecked downcast from PyObject to Self. Undefined behavior if the input object does not have the expected type.

fn as_object(&self) -> &PyObject

Casts the Python object to PyObject.

fn into_object(self) -> PyObject

Casts the Python object to PyObject.

impl PythonObjectWithCheckedDowncast for PySet

fn downcast_from<'p>(
    py: Python<'p>,
    obj: PyObject
) -> Result<PySet, PythonObjectDowncastError<'p>>

Cast from PyObject to a concrete Python object type.

fn downcast_borrow_from<'a, 'p>(
    py: Python<'p>,
    obj: &'a PyObject
) -> Result<&'a PySet, PythonObjectDowncastError<'p>>

Cast from PyObject to a concrete Python object type.

impl PythonObjectWithTypeObject for PySet

fn type_object(py: Python<'_>) -> PyType

Retrieves the type object for this Python object type.

impl ToPyObject for PySet

Identity conversion: allows using existing PyObject instances where T: ToPyObject is expected.

type ObjectType = PySet

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

Converts self into a Python object.

fn into_py_object(self, _py: Python<'_>) -> PySet

Converts self into a Python object.

fn with_borrowed_ptr<F, R>(&self, _py: Python<'_>, f: F) -> Rwhere
    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.