pub enum PlayerCommand {
Show 26 variants
Play(QueueItemId),
Pause,
Resume,
Stop,
Seek(u64),
NextTrack,
PrevTrack,
AddToPlaylist(Vec<PlaylistItem>),
RemoveFromPlaylist(QueueItemId),
RemoveFromPlaylistBatch(Vec<QueueItemId>),
MoveInPlaylist {
id: QueueItemId,
target: QueueItemId,
after: bool,
},
MoveItemsInPlaylist {
ids: Vec<QueueItemId>,
target: QueueItemId,
after: bool,
},
UpdatePaths(Vec<(QueueItemId, PathBuf)>),
InsertInPlaylist {
items: Vec<PlaylistItem>,
after: QueueItemId,
},
ClearPlaylist,
ReplacePlaylist {
items: Vec<PlaylistItem>,
start: usize,
},
TrackReady(QueueItemId),
TrackStreamReady(QueueItemId),
TrackFailed(QueueItemId),
DecodeFinished,
Undo,
Redo,
BeginUndoBatch,
EndUndoBatch,
SetOutputDevice(String),
ClearOutputDevice,
}Expand description
Commands from the UI layer to the audio engine.
Variants§
Play(QueueItemId)
Set cursor + start playback. Replaces Play/SkipTo/SkipBack/PlayInterrupt.
Pause
Resume
Stop
Seek(u64)
NextTrack
PrevTrack
AddToPlaylist(Vec<PlaylistItem>)
RemoveFromPlaylist(QueueItemId)
RemoveFromPlaylistBatch(Vec<QueueItemId>)
Batch remove: delete multiple items as a single undoable operation.
MoveInPlaylist
MoveItemsInPlaylist
Batch move: extract ids and reinsert them at target position.
UpdatePaths(Vec<(QueueItemId, PathBuf)>)
Update file paths for playlist items after an organize operation. On Unix, rename() doesn’t invalidate open FDs so playback continues.
InsertInPlaylist
Insert items after a specific queue item (for drag/drop at cursor position).
ClearPlaylist
Clear the entire playlist (stop + remove all items).
ReplacePlaylist
Replace the playlist and start playing at start, as one operation.
Doing this as ClearPlaylist + AddToPlaylist + Play sends three commands down a bounded channel, and the player acts on each as it arrives: the first track starts, then the cursor jumps. Clicking track nine of an album visibly flashed track one as playing first. It is also three undo entries for one user action.
start past the end starts at the beginning.
TrackReady(QueueItemId)
Download complete — check if cursor is waiting on this item.
TrackStreamReady(QueueItemId)
Enough data buffered for streaming playback — check if cursor is waiting.
TrackFailed(QueueItemId)
Download failed — a cursor parked on this item must stop waiting.
Without it the player sits on a Pending item forever: Ready is the
only thing it listens for, and a track that cannot be fetched never
becomes Ready. That is the offline-library stall.
DecodeFinished
Decode thread exhausted the playlist — auto-advance or stop.
Undo
Undo the last reversible playlist operation.
Redo
Redo the last undone operation.
BeginUndoBatch
Begin collecting undo entries into a single batch (e.g. drag operations).
EndUndoBatch
End the batch — collapse collected entries into one undo step.
SetOutputDevice(String)
Switch output audio device by name. Restarts engine on current track.
ClearOutputDevice
Clear the configured output device, reverting to system default.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for PlayerCommand
impl RefUnwindSafe for PlayerCommand
impl Send for PlayerCommand
impl Sync for PlayerCommand
impl Unpin for PlayerCommand
impl UnsafeUnpin for PlayerCommand
impl UnwindSafe for PlayerCommand
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<S, T> Duplex<S> for Twhere
T: FromSample<S> + ToSample<S>,
Source§impl<S> FromSample<S> for S
impl<S> FromSample<S> for S
fn from_sample_(s: S) -> S
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
impl<F, T> IntoSample<T> for Fwhere
T: FromSample<F>,
fn into_sample(self) -> T
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);