Struct pyo3::types::PyFrozenSet

[+] Show declaration

[+] Expand attributes
#[repr(transparent)]pub struct PyFrozenSet(_);

[−] Expand description

Represents a Python frozenset

Implementations

impl PyFrozenSet[−]

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

Creates a new frozenset.

May panic when running out of memory.

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

Creates a new empty frozen 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: ToBorrowedObject, [−]

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

pub fn iter(&self) -> PySetIterator<'_>[−]

Returns an iterator of values in this frozen set.

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

Methods from Deref<Target = PyAny>

pub fn downcast<T>(&self) -> Result<&T, PyDowncastError> where
    T: PyTryFrom<'py>, [−]

Convert this PyAny to a concrete Python type.

pub fn hasattr<N>(&self, attr_name: N) -> PyResult<bool> where
    N: ToPyObject, [−]

Determines whether this object has the given attribute.

This is equivalent to the Python expression hasattr(self, attr_name).

pub fn getattr<N>(&self, attr_name: N) -> PyResult<&PyAny> where
    N: ToPyObject, [−]

Retrieves an attribute value.

This is equivalent to the Python expression self.attr_name.

pub fn setattr<N, V>(&self, attr_name: N, value: V) -> PyResult<()> where
    N: ToBorrowedObject,
    V: ToBorrowedObject, [−]

Sets an attribute value.

This is equivalent to the Python expression self.attr_name = value.

pub fn delattr<N>(&self, attr_name: N) -> PyResult<()> where
    N: ToPyObject, [−]

Deletes an attribute.

This is equivalent to the Python expression del self.attr_name.

pub fn compare<O>(&self, other: O) -> PyResult<Ordering> where
    O: ToPyObject, [−]

Compares two Python objects.

This is equivalent to:

if self == other:
    return Equal
elif a < b:
    return Less
elif a > b:
    return Greater
else:
    raise TypeError("PyAny::compare(): All comparisons returned false")

pub fn rich_compare<O>(
    &self,
    other: O,
    compare_op: CompareOp
) -> PyResult<&PyAny> where
    O: ToPyObject, [−]

Compares two Python objects.

Depending on the value of compare_op, this is equivalent to one of the following Python expressions:

• CompareOp::Eq: self == other
• CompareOp::Ne: self != other
• CompareOp::Lt: self < other
• CompareOp::Le: self <= other
• CompareOp::Gt: self > other
• CompareOp::Ge: self >= other

pub fn is_callable(&self) -> bool[−]

Determines whether this object is callable.

pub fn call(
    &self,
    args: impl IntoPy<Py<PyTuple>>,
    kwargs: Option<&PyDict>
) -> PyResult<&PyAny>[−]

Calls the object.

This is equivalent to the Python expression self(*args, **kwargs).

pub fn call0(&self) -> PyResult<&PyAny>[−]

Calls the object without arguments.

This is equivalent to the Python expression self().

pub fn call1(&self, args: impl IntoPy<Py<PyTuple>>) -> PyResult<&PyAny>[−]

Calls the object with only positional arguments.

This is equivalent to the Python expression self(*args).

pub fn call_method(
    &self,
    name: &str,
    args: impl IntoPy<Py<PyTuple>>,
    kwargs: Option<&PyDict>
) -> PyResult<&PyAny>[−]

Calls a method on the object.

This is equivalent to the Python expression self.name(*args, **kwargs).

Example

use pyo3::types::IntoPyDict;

let gil = Python::acquire_gil();
let py = gil.python();
let list = vec![3, 6, 5, 4, 7].to_object(py);
let dict = vec![("reverse", true)].into_py_dict(py);
list.call_method(py, "sort", (), Some(dict)).unwrap();
assert_eq!(list.extract::<Vec<i32>>(py).unwrap(), vec![7, 6, 5, 4, 3]);

let new_element = 1.to_object(py);
list.call_method(py, "append", (new_element,), None).unwrap();
assert_eq!(list.extract::<Vec<i32>>(py).unwrap(), vec![7, 6, 5, 4, 3, 1]);

pub fn call_method0(&self, name: &str) -> PyResult<&PyAny>[−]

Calls a method on the object without arguments.

This is equivalent to the Python expression self.name().

pub fn call_method1(
    &self,
    name: &str,
    args: impl IntoPy<Py<PyTuple>>
) -> PyResult<&PyAny>[−]

Calls a method on the object with only positional arguments.

This is equivalent to the Python expression self.name(*args).

pub fn is_true(&self) -> PyResult<bool>[−]

Returns whether the object is considered to be true.

This is equivalent to the Python expression bool(self).

pub fn is_none(&self) -> bool[−]

Returns whether the object is considered to be None.

This is equivalent to the Python expression self is None.

pub fn is_empty(&self) -> PyResult<bool>[−]

Returns true if the sequence or mapping has a length of 0.

This is equivalent to the Python expression len(self) == 0.

pub fn get_item<K>(&self, key: K) -> PyResult<&PyAny> where
    K: ToBorrowedObject, [−]

Gets an item from the collection.

This is equivalent to the Python expression self[key].

pub fn set_item<K, V>(&self, key: K, value: V) -> PyResult<()> where
    K: ToBorrowedObject,
    V: ToBorrowedObject, [−]

Sets a collection item value.

This is equivalent to the Python expression self[key] = value.

pub fn del_item<K>(&self, key: K) -> PyResult<()> where
    K: ToBorrowedObject, [−]

Deletes an item from the collection.

This is equivalent to the Python expression del self[key].

pub fn iter(&self) -> PyResult<PyIterator<'_>>[−]

Takes an object and returns an iterator for it.

This is typically a new iterator but if the argument is an iterator, this returns itself.

pub fn get_type(&self) -> &PyType[−]

Returns the Python type object for this object's type.

pub fn get_type_ptr(&self) -> *mut PyTypeObject[−]

Returns the Python type pointer for this object.

pub fn cast_as<'a, D>(&'a self) -> Result<&'a D, PyDowncastError> where
    D: PyTryFrom<'a>, [−]

Casts the PyObject to a concrete Python object type.

This can cast only to native Python types, not types implemented in Rust.

pub fn extract<'a, D>(&'a self) -> PyResult<D> where
    D: FromPyObject<'a>, [−]

Extracts some type from the Python object.

This is a wrapper function around FromPyObject::extract().

pub fn get_refcnt(&self) -> isize[−]

Returns the reference count for the Python object.

pub fn repr(&self) -> PyResult<&PyString>[−]

Computes the "repr" representation of self.

This is equivalent to the Python expression repr(self).

pub fn str(&self) -> PyResult<&PyString>[−]

Computes the "str" representation of self.

This is equivalent to the Python expression str(self).

pub fn hash(&self) -> PyResult<isize>[−]

Retrieves the hash code of self.

This is equivalent to the Python expression hash(obi).

pub fn len(&self) -> PyResult<usize>[−]

Returns the length of the sequence or mapping.

This is equivalent to the Python expression len(self).

pub fn dir(&self) -> &PyList[−]

Returns the list of attributes of this object.

This is equivalent to the Python expression dir(self).

Trait Implementations

impl AsPyPointer for PyFrozenSet[+]

fn as_ptr(&self) -> *mut PyObject[−]

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PyFrozenSet[+]

[+] Show hidden undocumented items

fn as_ref(&self) -> &PyAny[−]

Performs the conversion.

impl Debug for PyFrozenSet[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl Deref for PyFrozenSet[+]

[+] Show hidden undocumented items

type Target = PyAny

The resulting type after dereferencing.

fn deref(&self) -> &PyAny[−]

Dereferences the value.

impl Display for PyFrozenSet[+]

[+] Show hidden undocumented items

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

Formats the value using the given formatter.

impl<'a> From<&'a PyFrozenSet> for &'a PyAny[+]

[+] Show hidden undocumented items

fn from(ob: &'a PyFrozenSet) -> Self[−]

Performs the conversion.

impl<'py> FromPyObject<'py> for &'py PyFrozenSet[+]

[+] Show hidden undocumented items

fn extract(obj: &'py PyAny) -> PyResult<Self>[−]

Extracts Self from the source PyObject.

impl<'a> IntoIterator for &'a PyFrozenSet[+]

[+] Show hidden undocumented items

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<PyFrozenSet> for PyFrozenSet[+]

[+] Show hidden undocumented items

fn eq(&self, o: &PyFrozenSet) -> bool[−]

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

[+] Expand attributes

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

This method tests for !=.

impl PyLayout<PyFrozenSet> for PySetObject[+]

[+] Show hidden undocumented items

const IS_NATIVE_TYPE: bool

fn get_super(&mut self) -> Option<&mut T::BaseLayout>

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

unsafe fn py_drop(&mut self, _py: Python<'_>)

impl PyNativeType for PyFrozenSet[+]

[+] Show hidden undocumented items

fn py(&self) -> Python<'_>

unsafe fn unchecked_downcast(obj: &PyAny) -> &Self[−]

Cast &PyAny to &Self without no type checking.

impl PySizedLayout<PyFrozenSet> for PySetObject

impl PyTypeInfo for PyFrozenSet[+]

[+] Show hidden undocumented items

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

type Layout = PySetObject

Layout

type BaseLayout = PyObject

Layout of Basetype.

type Initializer = PyNativeTypeInitializer<Self>

Initializer for layout

type AsRefTarget = Self

Utility type to make AsPyRef work

const NAME: &'static str[−][−]

Class name

const MODULE: Option<&'static str>[−][−]

Module name, if any

fn type_object_raw(_py: Python<'_>) -> *mut PyTypeObject[−]

PyTypeObject instance for this type.

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 ToPyObject for PyFrozenSet[+]

[+] Show hidden undocumented items

fn to_object(&self, py: Python<'_>) -> PyObject[−]

Converts self into a Python object.