alex/nih-plug
1
0
Fork 0
Code Activity

Mention the panicking behavior of block smoothing

Browse source
This commit is contained in:
Robbert van der Helm 2022-03-01 20:22:42 +01:00
parent 3e8b2b3759
commit 8eafcebe62
1 changed files with 8 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
src/param/smoothing.rs
View file

@ -141,6 +141,10 @@ impl Smoother<f32> {
/// allocate memory for the block smoothing. /// allocate memory for the block smoothing.
/// ///
/// Returns a `None` value if the block length exceed's the allocated capacity. /// Returns a `None` value if the block length exceed's the allocated capacity.
///
/// # Panics
///
/// Panics if this function is called again while another block value slice is still alive.
#[inline] #[inline]
pub fn next_block(&self, block: &Block) -> Option<AtomicRefMut<[f32]>> { pub fn next_block(&self, block: &Block) -> Option<AtomicRefMut<[f32]>> {
let mut block_values = self.block_values.borrow_mut(); let mut block_values = self.block_values.borrow_mut();
@ -238,6 +242,10 @@ impl Smoother<i32> {
/// allocate memory for the block smoothing. /// allocate memory for the block smoothing.
/// ///
/// Returns a `None` value if the block length exceed's the allocated capacity. /// Returns a `None` value if the block length exceed's the allocated capacity.
///
/// # Panics
///
/// Panics if this function is called again while another block value slice is still alive.
#[inline] #[inline]
pub fn next_block(&self, block: &Block) -> Option<AtomicRefMut<[i32]>> { pub fn next_block(&self, block: &Block) -> Option<AtomicRefMut<[i32]>> {
let mut block_values = self.block_values.borrow_mut(); let mut block_values = self.block_values.borrow_mut();