Skip to main content

Hold

Struct Hold 

Source
#[repr(transparent)]
pub struct Hold<T>(pub T);
Expand description

Zero-order hold over optional input samples.

Some(x) updates the held value, while None repeats the previous one. This is useful for interpolation pipelines and event-driven sample streams.

Together with Downsample, this forms the scalar optional-sample pair: Downsample creates gaps by emitting None, while Hold turns those gaps back into a continuous stream by repeating the last present sample.

At the chunk level, Interpolator plays the analogous role for turning a scalar stream into chunk output.

§Examples

use dsp_process::{Hold, Process};

let mut hold = Hold(5);
assert_eq!(hold.process(None), 5);
assert_eq!(hold.process(Some(7)), 7);
assert_eq!(hold.process(None), 7);

Tuple Fields§

§0: T

Trait Implementations§

Source§

impl<T: Clone> Clone for Hold<T>

Source§

fn clone(&self) -> Hold<T>

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Copy> Copy for Hold<T>

Source§

impl<T: Debug> Debug for Hold<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T: Default> Default for Hold<T>

Source§

fn default() -> Hold<T>

Returns the “default value” for a type. Read more
Source§

impl<T: Copy> Process<Option<T>, T> for Hold<T>

Source§

fn process(&mut self, x: Option<T>) -> T

Update the state with a new input and obtain an output
Source§

fn block(&mut self, x: &[X], y: &mut [Y])

Process a block of inputs into a block of outputs Read more

Auto Trait Implementations§

§

impl<T> Freeze for Hold<T>
where T: Freeze,

§

impl<T> RefUnwindSafe for Hold<T>
where T: RefUnwindSafe,

§

impl<T> Send for Hold<T>
where T: Send,

§

impl<T> Sync for Hold<T>
where T: Sync,

§

impl<T> Unpin for Hold<T>
where T: Unpin,

§

impl<T> UnsafeUnpin for Hold<T>
where T: UnsafeUnpin,

§

impl<T> UnwindSafe for Hold<T>
where T: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.