Skip to main content

PipeBuffer

Struct PipeBuffer 

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

Single-producer, single-consumer buffer for intra-graph node connections.

Unlike its name suggests, this is not thread-safe — it is used exclusively within the single-threaded signal graph. For cross-thread communication use rill_core::queues.

Implementations§

Source§

impl<T, const N: usize> PipeBuffer<T, N>
where T: Transcendental,

Source

pub fn new() -> PipeBuffer<T, N>

Create a new empty pipe buffer.

Source

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

Write a block of data. Subsequent reads will return this data.

Source

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

Read the latest written data (non-destructive).

Source

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

Read the latest written data (destructive — clears the valid flag).

Source

pub fn read_blocking(&mut self) -> [T; N]

Busy-wait until data is available, then read destructively.

Source

pub fn has_data(&self) -> bool

Whether data is available for reading.

Source

pub fn write_seq(&self) -> usize

Number of writes performed.

Source

pub fn read_seq(&self) -> usize

Number of reads performed.

Source

pub fn is_caught_up(&self) -> bool

Whether all writes have been consumed by reads.

Source

pub fn overwrites(&self) -> usize

Number of times the buffer was overwritten before being read.

Source

pub fn reset(&mut self)

Reset to initial empty state.

Trait Implementations§

Source§

impl<T, const N: usize> Buffer<T> for PipeBuffer<T, N>
where T: Transcendental,

Source§

fn capacity(&self) -> usize

Maximum number of elements the buffer can hold.
Source§

fn len(&self) -> usize

Current number of elements in the buffer.
Source§

fn is_empty(&self) -> bool

Whether the buffer is empty (len() == 0).
Source§

fn is_full(&self) -> bool

Whether the buffer is full (len() == capacity()).
Source§

fn as_slice(&self) -> &[T]

Read-only access to the buffer data.
Source§

fn as_mut_slice(&mut self) -> &mut [T]

Mutable access to the buffer data.
Source§

fn fill(&mut self, value: T)

Fill the entire buffer with a value.
Source§

fn copy_from(&mut self, src: &[T])

Copy data from a slice. Copies min(src.len(), self.len()) samples.
Source§

fn clear(&mut self)

Remove all items from the buffer.
Source§

fn stats(&self) -> BufferStats

Snapshot of performance statistics.
Source§

fn reset_stats(&mut self)

Reset performance counters (not the data).
Source§

impl<T, const N: usize> Clone for PipeBuffer<T, N>
where T: Transcendental + Copy,

Source§

fn clone(&self) -> PipeBuffer<T, N>

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, const N: usize> Debug for PipeBuffer<T, N>
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> Default for PipeBuffer<T, N>
where T: Transcendental,

Source§

fn default() -> PipeBuffer<T, N>

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

Auto Trait Implementations§

§

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

§

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

§

impl<T, const N: usize> Send for PipeBuffer<T, N>

§

impl<T, const N: usize> Sync for PipeBuffer<T, N>

§

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

§

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

§

impl<T, const N: usize> UnwindSafe for PipeBuffer<T, N>
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> 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> 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 = 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.
Source§

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

Source§

fn vzip(self) -> V