Files
songbird/src/tracks/looping.rs
Kyle Simpson 94157b12bc Docs: Move to new intra-doc links, make events non-exhaustive. (#19)
Far cleaner and more reliable than the old doc-link pattern. Also allowed me to spot some event types and sources which should have been made non_exhaustive.
2020-11-24 19:52:23 +00:00

23 lines
535 B
Rust

/// Looping behaviour for a [`Track`].
///
/// [`Track`]: struct.Track.html
#[derive(Copy, Clone, Debug, Eq, PartialEq)]
pub enum LoopState {
/// Track will loop endlessly until loop state is changed or
/// manually stopped.
Infinite,
/// Track will loop `n` more times.
///
/// `Finite(0)` is the `Default`, stopping the track once its [`Input`] ends.
///
/// [`Input`]: crate::input::Input
Finite(usize),
}
impl Default for LoopState {
fn default() -> Self {
Self::Finite(0)
}
}