Struct TimedSwitchValues

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

Represents a switched 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

Implementations

impl<I: IntoIterator<Item = TimedValue<bool>> + Clone> TimedSwitchValues<I>

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

Construct a new TimedSwitchValues from an iterator of points.

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

Examples

assert!(TimedSwitchValues::new(
  vec![TimedValue { sample_offset: 0, value: false },
       TimedValue { sample_offset: 100, value: true }],
  128,
).is_some());

impl<I> TimedSwitchValues<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 TimedSwitchValues<I>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<I: IntoIterator<Item = TimedValue<bool>>> IntoIterator for TimedSwitchValues<I>

type Item = TimedValue<bool>

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.