Skip to main content

FanInBuffer

Struct FanInBuffer 

Source
pub struct FanInBuffer<T, const N: usize, const PRODUCERS: usize>
where T: Transcendental,
{ /* private fields */ }
Expand description

Buffer for mixing multiple producers to one consumer. Single-threaded — use rill_core::queues for cross-thread.

Implementations§

Source§

impl<T, const N: usize, const PRODUCERS: usize> FanInBuffer<T, N, PRODUCERS>
where T: Transcendental,

Source

pub fn new() -> FanInBuffer<T, N, PRODUCERS>

Create a new fan-in buffer.

§Panics

Panics if PRODUCERS is 0.

Source

pub fn write(&mut self, producer_id: usize, data: &[T; N])

Write a block of data from one producer.

Source

pub fn try_read(&mut self) -> Option<[T; N]>

Read and sum all producers’ data that have new writes since last read.

Source

pub const fn producer_count(&self) -> usize

Number of producers (const generic parameter).

Source

pub fn producer_has_data(&self, producer_id: usize) -> bool

Whether a specific producer has unread data.

Source

pub fn read_seq(&self) -> usize

Current read sequence counter.

Source

pub fn write_seq(&self, producer_id: usize) -> Option<usize>

Write sequence counter for a specific producer, or None if ID is invalid.

Source

pub fn reset(&mut self)

Reset all producers and the read counter.

Source

pub fn clear_producer(&mut self, producer_id: usize)

Clear a specific producer’s data without affecting others.

Trait Implementations§

Source§

impl<T, const N: usize, const PRODUCERS: usize> Debug for FanInBuffer<T, N, PRODUCERS>
where T: Transcendental + Debug,

Source§

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

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

impl<T, const N: usize, const PRODUCERS: usize> Default for FanInBuffer<T, N, PRODUCERS>
where T: Transcendental,

Source§

fn default() -> FanInBuffer<T, N, PRODUCERS>

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

impl<T, const N: usize, const PRODUCERS: usize> SignalBuffer<T> for FanInBuffer<T, N, PRODUCERS>
where T: Transcendental,

Source§

fn capacity(&self) -> usize

Get the total capacity of the buffer in samples Read more
Source§

fn len(&self) -> usize

Get the current number of items in the buffer Read more
Source§

fn is_empty(&self) -> bool

Check if the buffer is empty
Source§

fn is_full(&self) -> bool

Check if the buffer is full
Source§

fn clear(&mut self)

Clear all items from the buffer Read more
Source§

fn stats(&self) -> BufferStats

Get a snapshot of current buffer statistics
Source§

fn reset_stats(&mut self)

Reset all statistics to zero Read more

Auto Trait Implementations§

§

impl<T, const N: usize, const PRODUCERS: usize> !Freeze for FanInBuffer<T, N, PRODUCERS>

§

impl<T, const N: usize, const PRODUCERS: usize> RefUnwindSafe for FanInBuffer<T, N, PRODUCERS>
where T: RefUnwindSafe,

§

impl<T, const N: usize, const PRODUCERS: usize> Send for FanInBuffer<T, N, PRODUCERS>

§

impl<T, const N: usize, const PRODUCERS: usize> Sync for FanInBuffer<T, N, PRODUCERS>

§

impl<T, const N: usize, const PRODUCERS: usize> Unpin for FanInBuffer<T, N, PRODUCERS>
where T: Unpin,

§

impl<T, const N: usize, const PRODUCERS: usize> UnsafeUnpin for FanInBuffer<T, N, PRODUCERS>
where T: UnsafeUnpin,

§

impl<T, const N: usize, const PRODUCERS: usize> UnwindSafe for FanInBuffer<T, N, PRODUCERS>
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> AsAny for T
where T: 'static,

Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert to &dyn std::any::Any
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert to &mut dyn std::any::Any
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> 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.