[−][src]Struct pyo3::types::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]
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)
[src]
Empties 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 the Python expression len(self)
.
pub fn is_empty(&self) -> bool
[src]
Checks if the dict is empty, i.e. len(self) == 0
.
pub fn contains<K>(&self, key: K) -> PyResult<bool> where
K: ToBorrowedObject,
[src]
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,
[src]
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,
[src]
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,
[src]
K: ToBorrowedObject,
Deletes an item.
This is equivalent to the Python statement del self[key]
.
pub fn keys(&self) -> &PyList
[src]
Returns a list of dict keys.
This is equivalent to the Python expression list(dict.keys())
.
pub fn values(&self) -> &PyList
[src]
Returns a list of dict values.
This is equivalent to the Python expression list(dict.values())
.
pub fn items(&self) -> &PyList
[src]
Returns a list of dict items.
This is equivalent to the Python expression list(dict.items())
.
pub fn iter(&self) -> PyDictIterator
[src]
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
[src]
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<'py> FromPyObject<'py> for &'py PyDict
[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?
fn into_iter(self) -> Self::IntoIter
[src]
impl PartialEq<PyDict> for PyDict
[src]
impl PyLayout<PyDict> for PyDictObject
[src]
const IS_NATIVE_TYPE: bool
[src]
fn get_super(&mut self) -> Option<&mut T::BaseLayout>
[src]
unsafe fn py_init(&mut self, _value: T)
[src]
unsafe fn py_drop(&mut self, _py: Python)
[src]
impl PyNativeType for PyDict
[src]
impl PySizedLayout<PyDict> for PyDictObject
[src]
impl PyTypeInfo for PyDict
[src]
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
[src]
const MODULE: Option<&'static str>
[src]
fn type_object() -> &'static PyTypeObject
[src]
fn is_instance(ptr: &PyAny) -> bool
[src]
const DESCRIPTION: &'static str
[src]
const FLAGS: usize
[src]
fn is_exact_instance(object: &PyAny) -> bool
[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]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> FromPy<T> for T
[src]
impl<'p, T> FromPyPointer<'p> for T where
T: 'p + PyNativeType,
[src]
T: 'p + PyNativeType,
unsafe fn from_owned_ptr_or_opt(Python<'p>, *mut PyObject) -> Option<&'p T>
[src]
unsafe fn from_borrowed_ptr_or_opt(Python<'p>, *mut PyObject) -> Option<&'p T>
[src]
unsafe fn from_owned_ptr_or_panic(
py: Python<'p>,
ptr: *mut PyObject
) -> &'p Self
[src]
py: Python<'p>,
ptr: *mut PyObject
) -> &'p Self
unsafe fn from_owned_ptr(py: Python<'p>, ptr: *mut PyObject) -> &'p Self
[src]
unsafe fn from_owned_ptr_or_err(
py: Python<'p>,
ptr: *mut PyObject
) -> PyResult<&'p Self>
[src]
py: Python<'p>,
ptr: *mut PyObject
) -> PyResult<&'p Self>
unsafe fn from_borrowed_ptr_or_panic(
py: Python<'p>,
ptr: *mut PyObject
) -> &'p Self
[src]
py: Python<'p>,
ptr: *mut PyObject
) -> &'p Self
unsafe fn from_borrowed_ptr(py: Python<'p>, ptr: *mut PyObject) -> &'p Self
[src]
unsafe fn from_borrowed_ptr_or_err(
py: Python<'p>,
ptr: *mut PyObject
) -> PyResult<&'p Self>
[src]
py: Python<'p>,
ptr: *mut PyObject
) -> PyResult<&'p Self>
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, U> IntoPy<U> for T where
U: FromPy<T>,
[src]
U: FromPy<T>,
impl<'py, T> PyDowncastImpl for T where
T: 'py + PyNativeType,
[src]
T: 'py + PyNativeType,
unsafe fn unchecked_downcast(&PyAny) -> &T
[src]
fn __private__(&self) -> PrivateMarker
[src]
impl<'v, T> PyTryFrom<'v> for T where
T: PyDowncastImpl + PyTypeInfo + PyNativeType,
[src]
T: PyDowncastImpl + PyTypeInfo + PyNativeType,
fn try_from<V>(V) -> Result<&'v T, PyDowncastError> where
V: Into<&'v PyAny>,
[src]
V: Into<&'v PyAny>,
fn try_from_exact<V>(V) -> Result<&'v T, PyDowncastError> where
V: Into<&'v PyAny>,
[src]
V: Into<&'v PyAny>,
unsafe fn try_from_unchecked<V>(V) -> &'v T where
V: Into<&'v PyAny>,
[src]
V: Into<&'v PyAny>,
impl<T> PyTypeObject for T where
T: PyTypeInfo,
[src]
T: PyTypeInfo,
fn type_object() -> Py<PyType>
[src]
impl<T> ToBorrowedObject for T where
T: ToPyObject,
[src]
T: ToPyObject,
default fn with_borrowed_ptr<F, R>(&Self, Python, F) -> R where
F: FnOnce(*mut PyObject) -> R,
[src]
F: FnOnce(*mut PyObject) -> R,
impl<T> ToBorrowedObject for T where
T: ToPyObject + AsPyPointer,
[src]
T: ToPyObject + AsPyPointer,
impl<T> ToString for T where
T: Display + ?Sized,
[src]
T: Display + ?Sized,
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,