mirror of
https://github.com/RustAudio/rodio
synced 2024-11-10 06:04:16 +00:00
improve seek beyond end documentation
This commit is contained in:
parent
963a48491f
commit
c2c85e2332
3 changed files with 12 additions and 6 deletions
|
@ -209,8 +209,10 @@ impl Sink {
|
||||||
/// when you try to seek beyond the length of the source this function will seek
|
/// when you try to seek beyond the length of the source this function will seek
|
||||||
/// to the end of the source instead.
|
/// to the end of the source instead.
|
||||||
///
|
///
|
||||||
/// If the duration of the source is known and the seek position lies beyond
|
/// As long as the duration of the source is known seek is guarenteed to saturate
|
||||||
/// it the saturates, that is the position is then at the end of the source.
|
/// 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
|
/// # Errors
|
||||||
/// This function will return [`SeekError::NotSupported`] if one of the underlying
|
/// This function will return [`SeekError::NotSupported`] if one of the underlying
|
||||||
|
|
|
@ -363,8 +363,10 @@ where
|
||||||
/// when you seek beyond the sources length this function will seek to the
|
/// when you seek beyond the sources length this function will seek to the
|
||||||
/// end of the source instead.
|
/// end of the source instead.
|
||||||
///
|
///
|
||||||
/// If the duration of the source is known and the seek position lies beyond
|
/// As long as the duration of the source is known seek is guarenteed to saturate
|
||||||
/// it the saturates, that is the position is then at the end of the source.
|
/// 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
|
/// # Errors
|
||||||
/// This function will return [`SeekError::NotSupported`] if one of the underlying
|
/// This function will return [`SeekError::NotSupported`] if one of the underlying
|
||||||
|
|
|
@ -173,8 +173,10 @@ impl SpatialSink {
|
||||||
/// when you try to seek beyong the length of the source this function will seek
|
/// when you try to seek beyong the length of the source this function will seek
|
||||||
/// to the end of the source instead.
|
/// to the end of the source instead.
|
||||||
///
|
///
|
||||||
/// If the duration of the source is known and the seek position lies beyond
|
/// As long as the duration of the source is known seek is guarenteed to saturate
|
||||||
/// it the saturates, that is the position is then at the end of the source.
|
/// 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
|
/// # Errors
|
||||||
/// This function will return [`SeekError::NotSupported`] if one of the underlying
|
/// This function will return [`SeekError::NotSupported`] if one of the underlying
|
||||||
|
|
Loading…
Reference in a new issue