Struct pyo3::types::PySet

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

Represents a Python set

Methods

impl PySet

pub fn new<'p, T: ToPyObject>(
    py: Python<'p>,
    elements: &[T]
) -> PyResult<&'p PySet>

Creates a new set.

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

Creates a new empty set

pub fn clear(&self)

Remove all elements from the set.

pub fn len(&self) -> usize

Return the number of items in the set. This is equivalent to len(p) on a set.

pub fn is_empty(&self) -> bool

Check if set is empty.

pub fn contains<K>(&self, key: K) -> PyResult<bool> where
    K: ToPyObject, 

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

pub fn discard<K>(&self, key: K) where
    K: ToPyObject, 

Remove element from the set if it is present.

pub fn add<K>(&self, key: K) -> PyResult<()> where
    K: ToPyObject, 

Add element to the set.

pub fn pop(&self) -> Option<PyObject>

Remove and return an arbitrary element from the set

Trait Implementations

impl AsPyPointer for PySet

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl ToPyObject for PySet

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

Converts self into a Python object.

impl PyNativeType for PySet

fn py(&self) -> Python

impl PyTypeInfo for PySet

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 PySet

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 PySet

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 PySet

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl PartialEq<PySet> for PySet

fn eq(&self, o: &PySet) -> 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 PySet> for &'a PyAny

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

Performs the conversion.

impl Display for PySet

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

Formats the value using the given formatter.

impl Debug for PySet

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

Formats the value using the given formatter.