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>

Returns a new dictionary that contains the same key-value pairs as self.

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

pub fn clear(&self)

Empties 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 the Python expression len(self).

pub fn is_empty(&self) -> bool

Checks if the dict is empty, i.e. len(self) == 0.

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

Determines 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.

To get a KeyError for non-existing keys, use ObjectProtocol::get_item.

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 statement self[key] = value.

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

Deletes an item.

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

pub fn keys(&self) -> &PyList

Returns a list of dict keys.

This is equivalent to the Python expression list(dict.keys()).

pub fn values(&self) -> &PyList

Returns a list of dict values.

This is equivalent to the Python expression list(dict.values()).

pub fn items(&self) -> &PyList

Returns a list of dict items.

This is equivalent to the Python expression list(dict.items()).

pub fn iter(&self) -> PyDictIterator

Returns an iterator of (key, value) pairs in this dictionary.

Note that it's unsafe to use when the dictionary might be changed by other code.

Trait Implementations

impl AsPyPointer for PyDict

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PyDict

fn as_ref(&self) -> &PyAny

Performs the conversion.

impl Debug for PyDict

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

Formats the value using the given formatter.

impl Display for PyDict

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

Formats the value using the given formatter.

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

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

Performs the conversion.

impl<'py> FromPyObject<'py> for &'py PyDict

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

Extracts Self from the source PyObject.

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 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 PyLayout<PyDict> for PyDictObject

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 PyDict

fn py(&self) -> Python

impl PySizedLayout<PyDict> for PyDictObject

impl PyTypeInfo for PyDict

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

type Layout = PyDictObject

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() -> &'static 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 PyDict

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

Converts self into a Python object.