Struct Cell 

pub struct Cell<S: Signal>(/* private fields */);

A wrapper around UnsafeCell, which allows us to reference a signal that might be modified.

For safety reasons, we don’t allow access to the pointer &mut S. Instead, the signal must be read using the Signal methods, and modified using Cell::modify.

Implementations

impl<S: Signal> Cell<S>

pub const fn new(sgn: S) -> Self

Initializes a new Cell.

pub fn modify<F: FnMut(&mut S)>(&self, func: F)

Modify the signal through the function.

Although this should be safe, note that it’s subject to the same pitfalls as the nightly Cell::update. Particularly, you should avoid nested calls.

impl<S: SignalMut> Cell<S>

pub fn advance(&self)

Advances the signal. Note that this only requires &self.

pub fn next(&self) -> S::Sample

Gets the next sample and advances the state of the signal. Note that this only requires &self.

Trait Implementations

impl<S: Signal> AsMut<S> for Cell<S>

If we own &mut Cell<S>, it must be the only reference.

fn as_mut(&mut self) -> &mut S

Converts this type into a mutable reference of the (usually inferred) input type.

impl<S: Done> Done for Cell<S>

fn is_done(&self) -> bool

Returns whether the signal has stopped producing any sound altogether. If this returns true once, it must return true in all successive times, unless retriggered.

impl<S: Signal> Signal for Cell<S>

type Sample = <S as Signal>::Sample

The type of sample generated by the signal.

fn get(&self) -> Self::Sample

Gets the next sample from the signal.

fn _get(&self) -> Self::Sample

Currently, rust-analyzer trips up sometimes that get is called, confusing it with Array::get. This hack bypasses this.