Struct PyDict

pub struct PyDict<K>
where
    K: Eq + Hash + PyDictKey,
{ /* private fields */ }

Implementations

impl<K> PyDict<K>

where K: Eq + Hash + PyDictKey,

pub fn new() -> PyDict<K>

Creates an empty PyDict.

pub fn insert<V>(&mut self, k: K, v: V) -> Option<V>

where PyArg: From<V>, V: From<PyArg>,

Inserts a key-value pair into the map.

If the map did not have this key present, None is returned.

If the map did have this key present, the value is updated, and the old value is returned. The key is not updated, though; this matters for types that can be == without being identical. See the module-level documentation for more.

pub fn remove<V>(&mut self, k: &K) -> Option<V>

where V: From<PyArg>,

Removes a key from the map, returning the value at the key if the key was previously in the map.

The key may be any borrowed form of the map’s key type, but Hash and Eq on the borrowed form must match those for the key type.

pub fn get<'a, V>(&'a self, k: &K) -> Option<&'a V>

where PyArg: AsRef<V>,

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map’s key type, but Hash and Eq on the borrowed form must match those for the key type.

pub unsafe fn from_ptr(ptr: *mut size_t) -> PyDict<K>

Get a PyDict from a previously boxed PyDict.

Takes the key as type parameter K, the raw pointer to the dictionary as argument and returns a PyDict with key type K (check PyArg variants for allowed key types).

let dict = unsafe { PyDict::<u64>::from_ptr(dict) };

pub fn into_raw(self) -> *mut size_t

Returns self as raw pointer. Use this method when returning a PyDict to Python.

pub fn into_hashmap<V>(self) -> HashMap<K, V>

where V: From<PyArg>,

Consumes self and returns a HashMap, takes one type parameter and transforms inner content to that type.

pub fn speciallized_iter<V: From<PyArg>>(self) -> IntoIter<K, V>

Consume self and turn it into an iterator.

Trait Implementations

impl<K> AsRef<PyDict<K>> for PyArg

where K: Eq + Hash + PyDictKey,

fn as_ref(&self) -> &PyDict<K>

Converts this type into a shared reference of the (usually inferred) input type.

impl<K> Clone for PyDict<K>

where K: Eq + Hash + PyDictKey + Clone,

fn clone(&self) -> PyDict<K>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K> Debug for PyDict<K>

where K: Eq + Hash + PyDictKey + Debug,

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

Formats the value using the given formatter.

impl<K> Default for PyDict<K>

where K: Eq + Hash + PyDictKey + Default,

fn default() -> PyDict<K>

Returns the “default value” for a type.

impl<K, V> From<HashMap<K, V>> for PyDict<K>

where K: PyDictKey + Eq + Hash, PyArg: From<V>,

fn from(hm: HashMap<K, V>) -> PyDict<K>

Converts to this type from the input type.

impl<K> From<PyArg> for PyDict<K>

where K: Eq + Hash + PyDictKey,

fn from(a: PyArg) -> PyDict<K>

Converts to this type from the input type.

impl<K> From<PyDict<K>> for PyArg

where K: Eq + Hash + PyDictKey,

fn from(a: PyDict<K>) -> PyArg

Converts to this type from the input type.

impl<K, V> FromIterator<(K, V)> for PyDict<K>

where K: PyDictKey + Eq + Hash, PyArg: From<V>,

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl<K> PartialEq for PyDict<K>

where K: Eq + Hash + PyDictKey + PartialEq,

fn eq(&self, other: &PyDict<K>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K> StructuralPartialEq for PyDict<K>

where K: Eq + Hash + PyDictKey,