[][src]Struct pyo3::types::PyDict

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

Represents a Python dict.

Methods

impl PyDict[src]

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

Creates a new empty dictionary.

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

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>[src]

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

pub fn clear(&self)[src]

Empty an existing dictionary of all key-value pairs.

pub fn len(&self) -> usize[src]

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

pub fn is_empty(&self) -> bool[src]

Check if dict is empty.

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

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
[src]

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
[src]

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
[src]

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

pub fn keys(&self) -> &PyList[src]

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

pub fn values(&self) -> &PyList[src]

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

pub fn items(&self) -> &PyList[src]

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

pub fn iter(&self) -> PyDictIterator[src]

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[src]

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

Gets the underlying FFI pointer, returns a borrowed pointer.

impl AsRef<PyAny> for PyDict[src]

impl Debug for PyDict[src]

impl Display for PyDict[src]

impl<'a> From<&'a PyDict> for &'a PyAny[src]

impl<'a> IntoIterator for &'a PyDict[src]

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?

impl PartialEq<PyDict> for PyDict[src]

impl PyNativeType for PyDict[src]

impl PyObjectAlloc for PyDict[src]

impl PyTypeInfo for PyDict[src]

type Type = ()

Type of objects to store in PyObject struct

type BaseType = PyAny

Base class

impl PyTypeObject for PyDict[src]

impl ToPyObject for PyDict[src]

Auto Trait Implementations

impl !RefUnwindSafe for PyDict

impl !Send for PyDict

impl !Sync for PyDict

impl Unpin for PyDict

impl UnwindSafe for PyDict

Blanket Implementations

impl<T> Any for T where
    T: 'static + ?Sized
[src]

impl<T> Borrow<T> for T where
    T: ?Sized
[src]

impl<T> BorrowMut<T> for T where
    T: ?Sized
[src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, 
[src]

impl<T> PyObjectAlloc for T where
    T: PyObjectWithFreeList
[src]

impl<T> PyTypeCreate for T where
    T: PyObjectAlloc + PyTypeObject
[src]

impl<T> PyTypeObject for T where
    T: PyTypeInfo + PyMethodsProtocol + PyObjectAlloc
[src]

impl<T> ToString for T where
    T: Display + ?Sized
[src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 
[src]

type Error = !

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 
[src]

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.