Skip to main content

WindowBuffer

Struct WindowBuffer 

Source
pub struct WindowBuffer { /* private fields */ }
Expand description

Streaming buffer that accumulates samples and yields full windows.

Maintains an internal ring-like buffer. Call extend with incoming chunks, then repeatedly call try_pop to consume every window that is ready.

Implementations§

Source§

impl WindowBuffer

Source

pub fn new(win: usize, hop: usize) -> Self

{ win > 0 && hop > 0 } pub fn new(win: usize, hop: usize) -> Self { true } Create a new buffer.

  • win — window size in samples.
  • hop — hop size in samples.
§Panics

Panics if win == 0, hop == 0, or hop > win. Use try_new for a fallible alternative.

Source

pub fn try_new(win: usize, hop: usize) -> Result<Self, WindowError>

{ true } pub fn try_new(win: usize, hop: usize) -> Result<Self, WindowError> { ret.is_ok() == (win > 0 && hop > 0 && hop <= win) } Fallible constructor: validates the window geometry and returns WindowError instead of panicking.

  • win — window size in samples (must be > 0).
  • hop — hop size in samples (must be > 0 and <= win).
Source

pub fn extend(&mut self, samples: &[f32])

{ true } pub fn extend(&mut self, samples: &[f32]) { true } Append samples to the buffer.

Source

pub fn try_pop(&mut self) -> Option<(usize, Vec<f32>)>

{ true } pub fn try_pop(&mut self) -> Option<(usize, Vec<f32>)> { ret.as_ref().map(|(_, w)| w.len() == self.win) } Return the next full window if one is available.

Returns Some((global_start, buf[..win].to_vec())) where global_start is the sample offset of this window relative to the start of the stream. The window is cloned so that the internal buffer can advance immediately.

Source

pub fn flush(&mut self) -> Option<(usize, Vec<f32>)>

{ true } pub fn flush(&mut self) -> Option<(usize, Vec<f32>)> { true } Zero-pad the remaining buffer to win and return the final window.

Returns None if the buffer is empty.

Source

pub fn is_empty(&self) -> bool

{ true } pub fn is_empty(&self) -> bool { ret == (self.buf.len() == 0) } Whether the buffer is currently empty.

Source

pub fn len(&self) -> usize

{ true } pub fn len(&self) -> usize { ret == self.buf.len() } Current length of the buffered samples.

Source

pub fn clear(&mut self)

{ true } pub fn clear(&mut self) { self.buf.is_empty() } Clear all buffered samples and reset the next-start offset.

Source

pub fn set_next_start(&mut self, start: usize)

{ true } pub fn set_next_start(&mut self, start: usize) { self.next_start == start } Set the next-start offset to a specific value.

Trait Implementations§

Source§

impl Clone for WindowBuffer

Source§

fn clone(&self) -> Self

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 Debug for WindowBuffer

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> ByRef<T> for T

Source§

fn by_ref(&self) -> &T

Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DistributionExt for T
where T: ?Sized,

Source§

fn rand<T>(&self, rng: &mut (impl Rng + ?Sized)) -> T
where Self: Distribution<T>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Imply<T> for U
where T: ?Sized, U: ?Sized,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more