[−][src]Struct vapoursynth::map::MapRefMut
A reference to a mutable VapourSynth map.
Methods from Deref<Target = Map<'elem>>
pub fn clear(&mut self)
[src]
Clears the map.
pub fn error(&self) -> Option<Cow<str>>
[src]
Returns the error message contained in the map, if any.
pub fn set_error(&mut self, error_message: &str) -> Result<()>
[src]
Adds an error message to a map. The map is cleared first.
pub fn key_count(&self) -> usize
[src]
Returns the number of keys contained in a map.
pub fn key(&self, index: usize) -> &str
[src]
ⓘImportant traits for Keys<'map, 'elem>pub fn keys(&self) -> Keys
[src]
Returns an iterator over all keys in a map.
pub fn value_count(&self, key: &str) -> Result<usize>
[src]
Returns the number of elements associated with a key in a map.
pub fn value_type(&self, key: &str) -> Result<ValueType>
[src]
Retrieves a value type from a map.
pub fn delete_key(&mut self, key: &str) -> Result<()>
[src]
Deletes the given key.
pub fn touch(&mut self, key: &str, value_type: ValueType) -> Result<()>
[src]
Touches the key. That is, if the key exists, nothing happens, otherwise a key is created with no values associated.
pub fn get<'map, T: Value<'map, 'elem>>(&'map self, key: &str) -> Result<T>
[src]
Retrieves a property value.
pub fn get_iter<'map, T: Value<'map, 'elem>>(
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, T>>
[src]
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, T>>
Retrieves an iterator over the map values.
pub fn set<'map, T: Value<'map, 'elem>>(
&'map mut self,
key: &str,
x: &T
) -> Result<()>
[src]
&'map mut self,
key: &str,
x: &T
) -> Result<()>
Sets a property value.
pub fn append<'map, T: Value<'map, 'elem>>(
&'map mut self,
key: &str,
x: &T
) -> Result<()>
[src]
&'map mut self,
key: &str,
x: &T
) -> Result<()>
Appends a property value.
pub fn get_int(&self, key: &str) -> Result<i64>
[src]
Retrieves an integer from a map.
This function retrieves the first value associated with the key.
pub fn get_int_iter<'map>(
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, i64>>
[src]
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, i64>>
Retrieves integers from a map.
pub fn get_int_array(&self, key: &str) -> Result<&[i64]>
[src]
Retrieves an array of integers from a map.
This is faster than iterating over a get_int_iter()
.
pub fn get_float(&self, key: &str) -> Result<f64>
[src]
Retrieves a floating point number from a map.
This function retrieves the first value associated with the key.
pub fn get_float_array(&self, key: &str) -> Result<&[f64]>
[src]
Retrieves an array of floating point numbers from a map.
This is faster than iterating over a get_float_iter()
.
pub fn get_float_iter<'map>(
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, f64>>
[src]
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, f64>>
Retrieves floating point numbers from a map.
pub fn get_data(&self, key: &str) -> Result<&[u8]>
[src]
Retrieves data from a map.
This function retrieves the first value associated with the key.
pub fn get_data_iter<'map>(
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, &'map [u8]>>
[src]
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, &'map [u8]>>
Retrieves data from a map.
pub fn get_node(&self, key: &str) -> Result<Node<'elem>>
[src]
Retrieves a node from a map.
This function retrieves the first value associated with the key.
pub fn get_node_iter<'map>(
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, Node<'elem>>>
[src]
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, Node<'elem>>>
Retrieves nodes from a map.
pub fn get_frame(&self, key: &str) -> Result<FrameRef<'elem>>
[src]
Retrieves a frame from a map.
This function retrieves the first value associated with the key.
pub fn get_frame_iter<'map>(
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, FrameRef<'elem>>>
[src]
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, FrameRef<'elem>>>
Retrieves frames from a map.
pub fn get_function(&self, key: &str) -> Result<Function<'elem>>
[src]
Retrieves a function from a map.
This function retrieves the first value associated with the key.
pub fn get_function_iter<'map>(
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, Function<'elem>>>
[src]
&'map self,
key: &str
) -> Result<ValueIter<'map, 'elem, Function<'elem>>>
Retrieves functions from a map.
pub fn append_int(&mut self, key: &str, x: i64) -> Result<()>
[src]
Appends an integer to a map.
pub fn append_float(&mut self, key: &str, x: f64) -> Result<()>
[src]
Appends a floating point number to a map.
pub fn append_data(&mut self, key: &str, x: &[u8]) -> Result<()>
[src]
Appends data to a map.
pub fn append_node(&mut self, key: &str, x: &Node<'elem>) -> Result<()>
[src]
Appends a node to a map.
pub fn append_frame(&mut self, key: &str, x: &Frame<'elem>) -> Result<()>
[src]
Appends a frame to a map.
pub fn append_function(&mut self, key: &str, x: &Function<'elem>) -> Result<()>
[src]
Appends a function to a map.
pub fn set_int(&mut self, key: &str, x: i64) -> Result<()>
[src]
Sets a property value to an integer.
pub fn set_int_array(&mut self, key: &str, x: &[i64]) -> Result<()>
[src]
Sets a property value to an integer array.
This is faster than calling append_int()
in a loop.
pub fn set_float(&mut self, key: &str, x: f64) -> Result<()>
[src]
Sets a property value to a floating point number.
pub fn set_float_array(&mut self, key: &str, x: &[f64]) -> Result<()>
[src]
Sets a property value to a floating point number array.
This is faster than calling append_float()
in a loop.
pub fn set_data(&mut self, key: &str, x: &[u8]) -> Result<()>
[src]
Sets a property value to data.
pub fn set_node(&mut self, key: &str, x: &Node<'elem>) -> Result<()>
[src]
Sets a property value to a node.
pub fn set_frame(&mut self, key: &str, x: &Frame<'elem>) -> Result<()>
[src]
Sets a property value to a frame.
pub fn set_function(&mut self, key: &str, x: &Function<'elem>) -> Result<()>
[src]
Sets a property value to a function.
Trait Implementations
impl<'owner, 'elem> Debug for MapRefMut<'owner, 'elem>
[src]
impl<'owner, 'elem> Deref for MapRefMut<'owner, 'elem>
[src]
type Target = Map<'elem>
The resulting type after dereferencing.
fn deref(&self) -> &Self::Target
[src]
impl<'owner, 'elem> DerefMut for MapRefMut<'owner, 'elem>
[src]
Auto Trait Implementations
impl<'owner, 'elem> Send for MapRefMut<'owner, 'elem>
impl<'owner, 'elem> Sync for MapRefMut<'owner, 'elem>
impl<'owner, 'elem> Unpin for MapRefMut<'owner, 'elem>
impl<'owner, 'elem> UnwindSafe for MapRefMut<'owner, 'elem>
impl<'owner, 'elem> RefUnwindSafe for MapRefMut<'owner, 'elem>
Blanket Implementations
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From<T> for T
[src]
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>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
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> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,