Struct MapRef

pub struct MapRef<'m> { /* private fields */ }

A borrowed reference to a ffi::VSMap.

Methods from Deref<Target = Map>

pub fn as_ptr(&self) -> *mut VSMap

Returns a raw pointer to the wrapped value.

pub fn clear(&mut self)

pub fn set_error(&mut self, msg: &CStr)

pub fn get_error(&self) -> Option<&CStr>

pub fn len(&self) -> i32

pub fn is_empty(&self) -> bool

pub fn get_key(&self, index: i32) -> &KeyStr

Panics

Panics if index is out of bounds.

pub fn delete_key(&mut self, key: &KeyStr)

pub fn num_elements(&self, key: &KeyStr) -> Option<i32>

pub fn get_int(&self, key: &KeyStr, index: i32) -> Result<i64, MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_float( &self, key: &KeyStr, index: i32, ) -> Result<f64, MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_binary( &self, key: &KeyStr, index: i32, ) -> Result<&[u8], MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_utf8( &self, key: &KeyStr, index: i32, ) -> Result<&str, MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_function( &self, key: &KeyStr, index: i32, ) -> Result<Function, MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_video_node( &self, key: &KeyStr, index: i32, ) -> Result<VideoNode, MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_audio_node( &self, key: &KeyStr, index: i32, ) -> Result<AudioNode, MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_video_frame( &self, key: &KeyStr, index: i32, ) -> Result<VideoFrame, MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_audio_frame( &self, key: &KeyStr, index: i32, ) -> Result<AudioFrame, MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get( &self, key: &KeyStr, index: i32, ) -> Result<Value<'_>, MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_int_saturated( &self, key: &KeyStr, index: i32, ) -> Result<i32, MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_int_array(&self, key: &KeyStr) -> Result<&[i64], MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_float_saturated( &self, key: &KeyStr, index: i32, ) -> Result<f32, MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn get_float_array(&self, key: &KeyStr) -> Result<&[f64], MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn set_empty(&mut self, key: &KeyStr, type_: VSPropertyType)

Panics

Panics if the key exists or is invalid

pub fn set( &mut self, key: &KeyStr, val: Value<'_>, append: AppendMode, ) -> Result<(), MapPropertyError>

Errors

Return MapPropertyError::InvalidType if the key’s type is not the same with val

Panics

Panic if the Value::Data’s or Value::Utf8’s len is larger than i32::MAX

pub fn set_int_array( &mut self, key: &KeyStr, val: &[i64], ) -> Result<(), MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

Panics

Panic if the val.len() is larger than i32::MAX

pub fn set_float_array( &mut self, key: &KeyStr, val: &[f64], ) -> Result<(), MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

Panics

Panic if the val.len() is larger than i32::MAX

pub fn consume_node( &mut self, key: &KeyStr, node: impl Node, append: AppendMode, ) -> Result<(), MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn consume_frame( &mut self, key: &KeyStr, frame: impl Frame, append: AppendMode, ) -> Result<(), MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

pub fn consume_function( &mut self, key: &KeyStr, function: Function, append: AppendMode, ) -> Result<(), MapPropertyError>

Errors

Return MapPropertyError if the underlying API does not success

Trait Implementations

impl<'m> Clone for MapRef<'m>

fn clone(&self) -> MapRef<'m>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'m> Debug for MapRef<'m>

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

Formats the value using the given formatter.

impl Deref for MapRef<'_>

type Target = Map

The resulting type after dereferencing.

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

Dereferences the value.

impl DerefMut for MapRef<'_>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'m> Hash for MapRef<'m>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'m> PartialEq for MapRef<'m>

fn eq(&self, other: &MapRef<'m>) -> 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<'m> Copy for MapRef<'m>

impl<'m> Eq for MapRef<'m>

impl<'m> StructuralPartialEq for MapRef<'m>