Mirrors/rodio
2
0
Fork 0
mirror of https://github.com/RustAudio/rodio synced 2024-09-20 06:02:00 +00:00
Code Issues Projects Releases Packages Wiki Activity

improve seek beyond end documentation

Browse source
This commit is contained in:
dvdsk 2023-10-13 15:21:18 +02:00
parent 963a48491f
commit c2c85e2332
No known key found for this signature in database
GPG key ID: 6CF9D20C5709A836
3 changed files with 12 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/sink.rs
View file

@ -209,8 +209,10 @@ impl Sink {
/// when you try to seek beyond the length of the source this function will seek
/// to the end of the source instead.
///
/// If the duration of the source is known and the seek position lies beyond
/// it the saturates, that is the position is then at the end of the source.
/// As long as the duration of the source is known seek is guarenteed to saturate
/// at the end of the source. For example given a source that reports a total duration
/// of 42 seconds calling `try_seek()` with 60 seconds as argument will seek to
/// 42 seconds.
///
/// # Errors
/// This function will return [`SeekError::NotSupported`] if one of the underlying

6
src/source/mod.rs
View file

@ -363,8 +363,10 @@ where
/// when you seek beyond the sources length this function will seek to the
/// end of the source instead.
///
/// If the duration of the source is known and the seek position lies beyond
/// it the saturates, that is the position is then at the end of the source.
/// As long as the duration of the source is known seek is guarenteed to saturate
/// at the end of the source. For example given a source that reports a total duration
/// of 42 seconds calling `try_seek()` with 60 seconds as argument will seek to
/// 42 seconds.
///
/// # Errors
/// This function will return [`SeekError::NotSupported`] if one of the underlying

6
src/spatial_sink.rs
View file

@ -173,8 +173,10 @@ impl SpatialSink {
/// when you try to seek beyong the length of the source this function will seek
/// to the end of the source instead.
///
/// If the duration of the source is known and the seek position lies beyond
/// it the saturates, that is the position is then at the end of the source.
/// As long as the duration of the source is known seek is guarenteed to saturate
/// at the end of the source. For example given a source that reports a total duration
/// of 42 seconds calling `try_seek()` with 60 seconds as argument will seek to
/// 42 seconds.
///
/// # Errors
/// This function will return [`SeekError::NotSupported`] if one of the underlying