Struct waver::Wave

pub struct Wave {
    pub sample_rate: f32,
    pub frequency: f32,
    pub phase: f32,
    pub amplitude: f32,
}

A structure that represent a sinusoidal wave.

The default value for a wave values is 0.0 except for the amplitude weight which is 1.0 (100% of available amplitude).

Fields

sample_rate: f32

The sampling rate of this wave.

frequency: f32

The frequency of this wave.

phase: f32

The phase of this wave.

amplitude: f32

The amplitude as a percentage [0.0 - 1.0].

Methods

impl Wave

Important traits for WaveIterator<'a>

impl<'a> Iterator for WaveIterator<'a> type Item = f32;

pub fn iter(&self) -> WaveIterator

An infinite iterator for the Wave structure.

The iterator will produce an infinite number of wave samples at the specified sampling rate and frequency.

Examples

use std::vec::Vec;
use waver::Wave;

let wave = Wave { sample_rate: 10000.0, frequency: 2000.0, ..Default::default() };
let res: Vec<f32> = wave.iter().take(10).collect();

Trait Implementations

impl Display for Wave

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

Formats the value using the given formatter.

impl Debug for Wave

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

Formats the value using the given formatter.

impl PartialEq<Wave> for Wave

fn eq(&self, other: &Wave) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Wave) -> bool

This method tests for !=.

impl<'a> IntoIterator for &'a Wave

type Item = f32

The type of the elements being iterated over.

type IntoIter = WaveIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Copy for Wave

impl Clone for Wave

fn clone(&self) -> Wave

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for Wave

fn default() -> Self

Returns the "default value" for a type.