Struct pyo3::PyDict

pub struct PyDict(_);

Represents a Python dict.

Methods

impl PyDict

fn new(py: Python) -> &PyDict

Creates a new empty dictionary.

May panic when running out of memory.

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

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

fn clear(&self)

Empty an existing dictionary of all key-value pairs.

fn len(&self) -> usize

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

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.

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

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

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.

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

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

fn keys(&self) -> &PyList

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

fn values(&self) -> &PyList

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

fn items(&self) -> &PyList

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

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 AsRef<PyObjectRef> for PyDict

fn as_ref(&self) -> &PyObjectRef

Performs the conversion.

impl PyObjectWithToken for PyDict

fn py(&self) -> Python

impl ToPyPointer for PyDict

fn as_ptr(&self) -> *mut PyObject

Gets the underlying FFI pointer, returns a borrowed pointer.

impl PartialEq for PyDict

fn eq(&self, o: &PyDict) -> bool

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

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PyTypeInfo for PyDict

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyObjectRef

Base class

const NAME: &'static str

NAME: &'static str = "PyDict"

Class name

const SIZE: usize

SIZE: usize = ::std::mem::size_of::<::ffi::PyObject>()

Size of the rust PyObject structure (PyObject + rust structure)

const OFFSET: isize

OFFSET: isize = 0

Type instance offset inside PyObject structure

unsafe fn type_object() -> &'static mut PyTypeObject

PyTypeObject instance for this type

fn is_instance(ptr: *mut PyObject) -> bool

Check if *mut ffi::PyObject is instance of this type

const DESCRIPTION: &'static str

DESCRIPTION: &'static str = "\u{0}"

Class doc string

const FLAGS: usize

FLAGS: usize = 0

Type flags (ie PY_TYPE_FLAG_GC, PY_TYPE_FLAG_WEAKREF)

fn is_exact_instance(ptr: *mut PyObject) -> bool

Check if *mut ffi::PyObject is exact instance of this type

impl PyTypeObject for PyDict

fn init_type()

Initialize type object

fn type_object() -> Py<PyType>

Retrieves the type object for this Python object type.

fn create(py: Python) -> PyResult<PyRawObject> where
    Self: Sized + PyObjectAlloc<Self> + PyTypeInfo, 

Create PyRawObject which can be initialized with rust value

impl ToPyObject for PyDict

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

Converts self into a Python object.

impl ToBorrowedObject for PyDict

fn with_borrowed_ptr<F, R>(&self, _py: Python, f: F) -> R where
    F: FnOnce(*mut PyObject) -> R, 

Converts self into a Python object and calls the specified closure on the native FFI pointer underlying the Python object.

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

fn extract(ob: &'a PyObjectRef) -> PyResult<Self>

Extracts Self from the source PyObject.

impl<'a> IntoIterator for &'a PyDict

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

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

fn into_dict_ptr(self, _py: Python) -> *mut PyObject

Converts self into a PyDict object pointer. Whether pointer owned or borrowed depends on implementation.