Struct dasp_signal::bus::Output

pub struct Output<S> where
    S: Signal,  { /* fields omitted */ }

An output node to which some signal S is Outputing its frames.

It may be more accurate to say that the Output "pull"s frames from the signal.

Required Features

• When using dasp_signal, this item requires the bus feature to be enabled.
• When using dasp, this item requires the signal-bus feature to be enabled.

Implementations

impl<S> Output<S> where
    S: Signal, 

pub fn pending_frames(&self) -> usize

The number of frames that have been requested from the Signal S by some other Output that have not yet been requested by this Output.

This is useful when using an Output to "monitor" some signal, allowing the user to drain only frames that have already been requested by some other Output.

Example

use dasp_signal::{self as signal, Signal};
use dasp_signal::bus::SignalBus;

fn main() {
    let frames = [[0.1], [0.2], [0.3]];
    let bus = signal::from_iter(frames.iter().cloned()).bus();
    let signal = bus.send();
    let mut monitor = bus.send();
    assert_eq!(signal.take(3).collect::<Vec<_>>(), vec![[0.1], [0.2], [0.3]]);
    assert_eq!(monitor.pending_frames(), 3);
    assert_eq!(monitor.next(), [0.1]);
    assert_eq!(monitor.pending_frames(), 2);
}

Required Features

• When using dasp_signal, this item requires the bus feature to be enabled.
• When using dasp, this item requires the signal-bus feature to be enabled.

Trait Implementations

impl<S> Drop for Output<S> where
    S: Signal, 

fn drop(&mut self)

Executes the destructor for this type.

impl<S> Signal for Output<S> where
    S: Signal, 

type Frame = S::Frame

The Frame type returned by the Signal.

fn next(&mut self) -> Self::Frame

Yield the next Frame in the Signal.

fn is_exhausted(&self) -> bool

Whether or not the signal is exhausted of meaningful frames.

fn map<M, F>(self, map: M) -> Map<Self, M, F> where
    Self: Sized,
    M: FnMut(Self::Frame) -> F,
    F: Frame, 

A signal that maps one set of frames to another.

fn zip_map<O, M, F>(self, other: O, map: M) -> ZipMap<Self, O, M, F> where
    Self: Sized,
    M: FnMut(Self::Frame, O::Frame) -> F,
    O: Signal,
    F: Frame, 

A signal that maps one set of frames to another.

fn add_amp<S>(self, other: S) -> AddAmp<Self, S> where
    Self: Sized,
    S: Signal,
    S::Frame: Frame<Sample = <<Self::Frame as Frame>::Sample as Sample>::Signed, NumChannels = <Self::Frame as Frame>::NumChannels>, 

Provides an iterator that yields the sum of the frames yielded by both other and self in lock-step.

fn mul_amp<S>(self, other: S) -> MulAmp<Self, S> where
    Self: Sized,
    S: Signal,
    S::Frame: Frame<Sample = <<Self::Frame as Frame>::Sample as Sample>::Float, NumChannels = <Self::Frame as Frame>::NumChannels>, 

Provides an iterator that yields the product of the frames yielded by both other and self in lock-step.

fn offset_amp(
    self,
    offset: <<Self::Frame as Frame>::Sample as Sample>::Signed
) -> OffsetAmp<Self> where
    Self: Sized, 

Provides an iterator that offsets the amplitude of every channel in each frame of the signal by some sample value and yields the resulting frames.

fn scale_amp(
    self,
    amp: <<Self::Frame as Frame>::Sample as Sample>::Float
) -> ScaleAmp<Self> where
    Self: Sized, 

Produces an Iterator that scales the amplitude of the sample of each channel in every Frame yielded by self by the given amplitude.

fn offset_amp_per_channel<F>(self, amp_frame: F) -> OffsetAmpPerChannel<Self, F> where
    Self: Sized,
    F: Frame<Sample = <<Self::Frame as Frame>::Sample as Sample>::Signed, NumChannels = <Self::Frame as Frame>::NumChannels>, 

Produces a new Signal that offsets the amplitude of every Frame in self by the respective amplitudes in each channel of the given amp_frame.

fn scale_amp_per_channel<F>(self, amp_frame: F) -> ScaleAmpPerChannel<Self, F> where
    Self: Sized,
    F: Frame<Sample = <<Self::Frame as Frame>::Sample as Sample>::Float, NumChannels = <Self::Frame as Frame>::NumChannels>, 

Produces a new Signal that scales the amplitude of every Frame in self by the respective amplitudes in each channel of the given amp_frame.

fn mul_hz<M, I>(self, interpolator: I, mul_per_frame: M) -> MulHz<Self, M, I> where
    Self: Sized,
    M: Signal<Frame = f64>,
    I: Interpolator, 

Multiplies the rate at which frames of self are yielded by the given signal.

fn from_hz_to_hz<I>(
    self,
    interpolator: I,
    source_hz: f64,
    target_hz: f64
) -> Converter<Self, I> where
    Self: Sized,
    I: Interpolator, 

Converts the rate at which frames of the Signal are yielded using interpolation.

fn scale_hz<I>(self, interpolator: I, multi: f64) -> Converter<Self, I> where
    Self: Sized,
    I: Interpolator, 

Multiplies the rate at which frames of the Signal are yielded by the given value.

fn delay(self, n_frames: usize) -> Delay<Self> where
    Self: Sized, 

Delays the Signal by the given number of frames.

fn into_interleaved_samples(self) -> IntoInterleavedSamples<Self> where
    Self: Sized, 

Converts a Signal into a type that yields the interleaved Samples.

fn clip_amp(
    self,
    thresh: <<Self::Frame as Frame>::Sample as Sample>::Signed
) -> ClipAmp<Self> where
    Self: Sized, 

Clips the amplitude of each channel in each Frame yielded by self to the given threshold amplitude.

fn inspect<F>(self, inspect: F) -> Inspect<Self, F> where
    Self: Sized,
    F: FnMut(&Self::Frame), 

Create a new Signal that calls the enclosing function on each iteration.

fn fork<S>(self, ring_buffer: Bounded<S>) -> Fork<Self, S> where
    Self: Sized,
    S: SliceMut<Element = Self::Frame>, 

Forks Self into two signals that produce the same frames.

fn take(self, n: usize) -> Take<Self> where
    Self: Sized, 

Converts the Signal into an Iterator that will yield the given number for Frames before returning None.

fn until_exhausted(self) -> UntilExhausted<Self> where
    Self: Sized, 

Converts the Signal into an Iterator yielding frames until the signal.is_exhausted() returns true.

fn buffered<S>(self, ring_buffer: Bounded<S>) -> Buffered<Self, S> where
    Self: Sized,
    S: Slice<Element = Self::Frame> + SliceMut, 

Buffers the signal using the given ring buffer.

fn by_ref(&mut self) -> &mut Self where
    Self: Sized, 

Borrows a Signal rather than consuming it.