Struct TimedEnumValues

pub struct TimedEnumValues<I> { /* private fields */ }

Represents an enum value that changes over the course of a buffer.

Each point represents a change in value at a given sample offset - the value remains constant until the next point (or the end of the buffer)

Some invariants:

• There will always be at least one point
• The first point’s sample_offset will be 0
• sample_offsets will be monotonically increasing and only one point will appear for each sample_offset
• All point’s value will be valid

Implementations

impl<I: IntoIterator<Item = TimedValue<u32>> + Clone> TimedEnumValues<I>

pub fn new( points: I, buffer_size: usize, valid_range: Range<u32>, ) -> Option<Self>

Construct a new TimedEnumValues from an iterator of points.

This will check the invariants for the curve, and if any are invalid, this will return None.

Note that here we refer to the enum by the index of the value, that is, the index of the value in the values array of the parameter.

Examples

assert!(TimedEnumValues::new(
  vec![TimedValue { sample_offset: 0, value: 0 },
       TimedValue { sample_offset: 100, value: 1 }],
  128,
  0..2,
).is_some());

impl<I> TimedEnumValues<I>

pub fn buffer_size(&self) -> usize

Get the size of the buffer this curve is defined over.

Trait Implementations

impl<I: Clone> Clone for TimedEnumValues<I>

fn clone(&self) -> TimedEnumValues<I>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<I: IntoIterator<Item = TimedValue<u32>>> IntoIterator for TimedEnumValues<I>

type Item = TimedValue<u32>

The type of the elements being iterated over.

type IntoIter = <I as IntoIterator>::IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.