Struct Dictionary

pub struct Dictionary { /* private fields */ }

A dictionary of key-value pairs.

Implementations

impl Dictionary

pub const fn new() -> Self

Creates a new dictionary.

pub const unsafe fn from_ptr_ref(ptr: *mut AVDictionary) -> Self

Wrap a pointer to a AVDictionary in a Dictionary. Without taking ownership of the dictionary.

Safety

ptr must be a valid pointer. The caller must also ensure that the dictionary is not freed while this object is alive, and that we don’t use the pointer as mutable

pub const unsafe fn from_ptr_owned(ptr: *mut AVDictionary) -> Self

Wrap a pointer to a AVDictionary in a Dictionary. Takes ownership of the dictionary. Meaning it will be freed when the Dictionary is dropped.

Safety

ptr must be a valid pointer.

pub fn set<'a>( &mut self, key: impl CStringLike<'a>, value: impl CStringLike<'a>, ) -> Result<(), FfmpegError>

Sets a key-value pair in the dictionary. Key and value must not be empty.

pub fn get<'a>(&self, key: impl CStringLike<'a>) -> Option<&CStr>

Returns the value associated with the given key. If the key is not found, the Option::None will be returned.

pub fn is_empty(&self) -> bool

Returns true if the dictionary is empty.

pub const fn iter(&self) -> DictionaryIterator<'_>

Returns an iterator over the dictionary.

pub const fn as_ptr(&self) -> *const AVDictionary

Returns the pointer to the dictionary.

pub const fn as_mut_ptr_ref(&mut self) -> &mut *mut AVDictionary

Returns a mutable reference to the pointer to the dictionary.

pub fn leak(self) -> *mut AVDictionary

Returns the pointer to the dictionary.

pub fn extend<'a, K, V>( &mut self, iter: impl IntoIterator<Item = (K, V)>, ) -> Result<(), FfmpegError>

where K: CStringLike<'a>, V: CStringLike<'a>,

Extends a dictionary with an iterator of key-value pairs.

pub fn try_from_iter<'a, K, V>( iter: impl IntoIterator<Item = (K, V)>, ) -> Result<Self, FfmpegError>

where K: CStringLike<'a>, V: CStringLike<'a>,

Creates a new dictionary from an iterator of key-value pairs.

Trait Implementations

impl Clone for Dictionary

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dictionary

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

Formats the value using the given formatter.

impl Default for Dictionary

fn default() -> Self

Returns the “default value” for a type.

impl<'a> IntoIterator for &'a Dictionary

type IntoIter = DictionaryIterator<'a>

Which kind of iterator are we turning this into?

type Item = <DictionaryIterator<'a> as Iterator>::Item

The type of the elements being iterated over.

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Send for Dictionary

Safety: Dictionary is safe to send between threads.