Struct Queue

pub struct Queue { /* private fields */ }

Implementations

impl Queue

pub const fn new() -> Self

pub fn add_song(&mut self, song: Song)

pub fn add_songs(&mut self, songs: Vec<Song>)

pub fn remove_song(&mut self, index: usize)

pub fn clear(&mut self)

pub fn current_song(&self) -> Option<&Song>

pub fn next_song(&mut self) -> Option<&Song>

pub fn skip_forward(&mut self, n: usize) -> Option<&Song>

Skip forward n songs in the queue.

progresses the current index by n, following the repeat mode rules.

pub fn previous_song(&mut self) -> Option<&Song>

pub fn skip_backward(&mut self, n: usize) -> Option<&Song>

pub fn set_repeat_mode(&mut self, repeat_mode: RepeatMode)

pub const fn get_repeat_mode(&self) -> RepeatMode

pub fn shuffle(&mut self)

pub fn get(&self, index: usize) -> Option<&Song>

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub const fn current_index(&self) -> Option<usize>

pub fn queued_songs(&self) -> Box<[Song]>

pub fn set_current_index(&mut self, index: usize)

Sets the current index, clamped to the nearest valid index.

pub fn remove_range(&mut self, range: Range<usize>)

Removes a range of songs from the queue. If the current index is within the range, it will be set to the next valid index (or the previous valid index if the range included the end of the queue).

Trait Implementations

impl Clone for Queue

fn clone(&self) -> Queue

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Queue

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Queue

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Queue

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Queue

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.