Struct rsmpeg::avutil::AVDictionary

pub struct AVDictionary { /* fields omitted */ }

Implementations

impl AVDictionary

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

pub fn as_mut_ptr(&mut self) -> *mut AVDictionary

pub unsafe fn set_ptr(&mut self, ptr: NonNull<AVDictionary>)

Safety

This function should only be called when the pointer is valid and the data it’s pointing to can be dropped.

pub unsafe fn from_raw(raw: NonNull<AVDictionary>) -> Self

Safety

This function should only be called when the pointer is valid and the data it’s pointing to can be dropped.

pub fn into_raw(self) -> NonNull<AVDictionary>

impl AVDictionary

pub fn new(key: &CStr, value: &CStr, flags: u32) -> Self

Create a dictionary while calling set().

pub fn new_int(key: &CStr, value: i64, flags: u32) -> Self

Create a dictionary while calling set_int().

pub fn from_string(
    str: &CStr,
    key_val_sep: &CStr,
    pairs_sep: &CStr,
    flags: u32
) -> Option<Self>

pub fn set(self, key: &CStr, value: &CStr, flags: u32) -> Self

The set function is so strange is because adding a new entry to AVDictionary invalidates all existing entries…. So this functions consumes itself.

pub fn set_int(self, key: &CStr, value: i64, flags: u32) -> Self

Similar to the set function.

pub fn parse_string(
    self,
    str: &CStr,
    key_val_sep: &CStr,
    pairs_sep: &CStr,
    flags: u32
) -> Result<Self>

Parse the key/value pairs list and add the parsed entries to a dictionary.

pub fn copy(self, another: &AVDictionary, flags: u32) -> Self

Copy entries from one AVDictionary struct into self.

pub fn get_string(&self, key_val_sep: u8, pairs_sep: u8) -> Result<CString>

Get dictionary entries as a string.

Create a string containing dictionary’s entries. Such string may be passed back to Self::parse_string().

impl<'dict> AVDictionary

pub fn get(
    &'dict self,
    key: &CStr,
    prev: Option<AVDictionaryEntryRef<'_>>,
    flags: u32
) -> Option<AVDictionaryEntryRef<'dict>>

Get a dictionary entry with matching key.

The returned entry key or value must not be changed, or it will cause undefined behavior.

To iterate through all the dictionary entries, you can set the matching key to the null string “” and set the AV_DICT_IGNORE_SUFFIX flag.

Trait Implementations

impl Clone for AVDictionary

fn clone(&self) -> Self

Similar to Self::copy(), while set the copy flag to 0.

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

Performs copy-assignment from source.

impl Deref for AVDictionary

type Target = AVDictionary

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl Drop for AVDictionary

fn drop(&mut self)

Executes the destructor for this type.