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

pub fn iter(&self) -> PySetIterator

Returns an iterator of values in this set.

Note that it can be unsafe to use when the set might be changed by other code.

Trait Implementations

impl AsPyPointer for PySet

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PySet

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Debug for PySet

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

Formats the value using the given formatter.

impl Display for PySet

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

Formats the value using the given formatter.

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

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

Performs the conversion.

impl<'a> IntoIterator for &'a PySet

type Item = &'a PyAny

The type of the elements being iterated over.

type IntoIter = PySetIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

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 PyNativeType for PySet

fn py(&self) -> Python

impl PyObjectLayout<PySet> for PySetObject

const IS_NATIVE_TYPE: bool

fn get_super_or(
    &mut self
) -> Option<&mut <T::BaseType as PyTypeInfo>::ConcreteLayout>

unsafe fn internal_ref_cast(obj: &PyAny) -> &T

unsafe fn internal_mut_cast(obj: &PyAny) -> &mut T

unsafe fn py_init(&mut self, _value: T)

unsafe fn py_drop(&mut self, _py: Python)

impl PyObjectSizedLayout<PySet> for PySetObject

impl PyTypeInfo for PySet

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

type ConcreteLayout = PySetObject

Layout

type Initializer = PyNativeTypeInitializer<Self>

Initializer for layout

const NAME: &'static str

Class name

const MODULE: Option<&'static str>

Module name, if any

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 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 ToPyObject for PySet

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

Converts self into a Python object.