Skip to content

Commit 42c5eec

Browse files
committed
note parameters_changed behaviour before first next
1 parent 23f8ac0 commit 42c5eec

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

src/source/mod.rs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,10 @@ pub use self::noise::{pink, white, PinkNoise, WhiteNoise};
158158
///
159159
pub trait Source: Iterator<Item = Sample> {
160160
/// Whether the value of `channels()` and/or `sample_rate()` have changed.
161-
/// This is true before the next call to `Source::next`. After the first
162-
/// `Source::next` call this will be false again.
161+
/// This is true before the next call to `Source::next`. After that
162+
/// `Source::next` call this will be false again.
163+
///
164+
/// The value before the first call to next is not defined.
163165
fn parameters_changed(&self) -> bool;
164166

165167
/// Returns the number of channels. Channels are always interleaved.

0 commit comments

Comments
 (0)