Struct pyo3::types::PyDict

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

Represents a Python dict.

Methods

impl PyDict

pub fn new(py: Python) -> &PyDict

Creates a new empty dictionary.

pub fn from_sequence(py: Python, seq: PyObject) -> PyResult<&PyDict>

Creates a new dictionary from the sequence given.

The sequence must consist of (PyObject, PyObject). This is equivalent to dict([("a", 1), ("b", 2)]).

Returns an error on invalid input. In the case of key collisions, this keeps the last entry seen.

pub fn copy(&self) -> PyResult<&PyDict>

Return a new dictionary that contains the same key-value pairs as self. Corresponds to dict(self) in Python.

pub fn clear(&self)

Empty an existing dictionary of all key-value pairs.

pub fn len(&self) -> usize

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

pub fn is_empty(&self) -> bool

Check if dict is empty.

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

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

pub fn get_item<K>(&self, key: K) -> Option<&PyAny> where
    K: ToBorrowedObject, 

Gets an item from the dictionary. Returns None if the item is not present, or if an error occurs.

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

Sets an 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. This is equivalent to the Python expression del self[key].

pub fn keys(&self) -> &PyList

List of dict keys. This is equivalent to the python expression list(dict.keys()).

pub fn values(&self) -> &PyList

List of dict values. This is equivalent to the python expression list(dict.values()).

pub fn items(&self) -> &PyList

List of dict items. This is equivalent to the python expression list(dict.items()).

pub fn iter(&self) -> PyDictIterator

Returns a iterator of (key, value) pairs in this dictionary Note that it's unsafe to use when the dictionary might be changed by other python code.

Trait Implementations

impl AsPyPointer for PyDict

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl ToPyObject for PyDict

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

Converts self into a Python object.

impl PyNativeType for PyDict

fn py(&self) -> Python

impl PyTypeInfo for PyDict

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

const NAME: &'static str

Class name

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 PyDict

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 PyDict

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<'a> From<&'a PyDict> for &'a PyAny

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

Performs the conversion.

impl PartialEq<PyDict> for PyDict

fn eq(&self, o: &PyDict) -> 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 AsRef<PyAny> for PyDict

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl<'a> IntoIterator for &'a PyDict

type Item = (&'a PyAny, &'a PyAny)

The type of the elements being iterated over.

type IntoIter = PyDictIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Display for PyDict

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

Formats the value using the given formatter.

impl Debug for PyDict

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

Formats the value using the given formatter.