Struct Queue

pub struct Queue { /* private fields */ }

A selection with a cursor and a deterministic playing order.

Implementations

impl Queue

pub fn new(tracks: Vec<Id>, seed: Option<u64>) -> Self

Build from the same ordered track IDs used by playlist rendering.

seed = None keeps the selection order. A seed shuffles it with a fixed algorithm, independently of platform or process state.

pub fn selection(&self) -> &[Id]

The original selection, including duplicate entries.

pub fn ordered_tracks(&self) -> impl Iterator<Item = Id> + '_

IDs in their current playing order.

pub fn seed(&self) -> Option<u64>

The shuffle seed, if the queue is shuffled.

pub fn current(&self) -> Option<Id>

The currently selected track.

pub fn cursor(&self) -> Option<usize>

The cursor in the current playing order.

pub fn current_entry(&self) -> Option<usize>

Original selection occurrence under the cursor, distinguishing repeats.

pub fn select_entry(&mut self, entry: usize) -> bool

Select an existing occurrence after the driver abandons preparation of a later source. Missing occurrences leave the queue unchanged.

pub fn order(&self) -> &[usize]

The current permutation of original selection occurrences.

pub fn reorder( &mut self, order: Vec<usize>, seed: Option<u64>, ) -> Result<(), &'static str>

Replace future order, retaining the played prefix and current occurrence.

order must contain every original occurrence exactly once. Invalid input leaves transport, history, seed and position unchanged. Changing mode clears saved neighbouring cycles, but not Previous within this one.

pub fn set_next_order( &mut self, order: Vec<usize>, seed: Option<u64>, ) -> Result<bool, &'static str>

Supply an externally planned next repeat-all cycle.

Return false when Previous has already retained the forward cycle. Such an order must not be silently replaced by a new shuffle draw.

pub fn next_seed(&self) -> Option<u64>

Reproducible seed for the next shuffled repeat-all cycle.

pub fn transport(&self) -> Transport

Current transport state.

pub fn position_ms(&self) -> u64

Position in the current track, supplied by the playback driver.

pub fn set_position_ms(&mut self, position_ms: u64) -> bool

Update the observed position after a successful playback or seek. An empty queue cannot acquire a position.

pub fn set_repeat(&mut self, repeat: Repeat)

Change how natural ends are handled.

pub fn repeat(&self) -> Repeat

The active repeat mode.

pub fn play(&mut self) -> Option<Id>

Start or resume the selected track; select the first entry if needed.

pub fn pause(&mut self)

Pause only while playing.

pub fn stop(&mut self)

Stop sound and return the selected track to its start.

pub fn skip_next(&mut self) -> Option<Id>

Skip to the next entry, even with repeat-one enabled. Keeps the current playing or paused state until the queue is exhausted.

pub fn finished(&mut self) -> Option<Id>

Advance after natural end; repeat-one restarts the current entry.

pub fn previous(&mut self) -> Option<Id>

Restart the current track after three seconds; otherwise step back. At the beginning of the current playing order, restart its first entry.

Trait Implementations

impl Clone for Queue

fn clone(&self) -> Queue

Returns a duplicate 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.