Enum LibraryCommand 

pub enum LibraryCommand {
    NewPlaylist {
        name: String,
        tracks: Option<Vec<PathBuf>>,
    },
    PlaylistFromM3U8 {
        name: String,
        m3u8_file: PathBuf,
    },
    DeletePlaylists {
        names: Vec<String>,
    },
    AddTracksToPlaylist {
        name: String,
        tracks: Vec<PathBuf>,
    },
    RemoveTracksFromPlaylist {
        name: String,
        ids: Vec<usize>,
    },
    GetLibrary,
    Rebuild,
    Reload,
}

Subcommand of Command for managing the music library.

The expected response may be different depending on the command sent. If it isn’t specified in the variant documentation, assume Response::Ok is the expected response.

Variants

NewPlaylist

Create a new playlist, optionally with some tracks in it.

Fields

name: String

The name for the new playlist. Must not already exist in the music library.

If a playlist with the specified name already exists, LibraryError::PlaylistExists will be returned, and no changes to the music library will be made.

tracks: Option<Vec<PathBuf>>

Optional list of paths to tracks to be added to the playlist.

This command will fail if any of the tracks are not registered in the music library, or if the list contains duplicates.

PlaylistFromM3U8

Import a playlist from an M3U8 file.

This is currently unimplemented and will cause the daemon to panic.

Fields

name: String

The name for the imported playlist. Must not already exist in the music library.

If a playlist with the specified name already exists, LibraryError::PlaylistExists will be returned, and no changes to the music library will be made.

m3u8_file: PathBuf

The path to the M3U8 file to import.

DeletePlaylists

Delete playlists from the music library.

Fields

names: Vec<String>

List of the playlists to delete.

If any of the provided playlists don’t exist in the music library, LibraryError::NoSuchPlaylist will be returned, and no changes to the music library will be made.

AddTracksToPlaylist

Add tracks to an already existing playlist.

Fields

name: String

The name of the playlist to add tracks to.

If a playlist with the specified name doesn’t exist in the music library, LibraryError::NoSuchPlaylist will be returned, and no changes to the music library will be made.

tracks: Vec<PathBuf>

List of paths to tracks to add to the playlist.

Note: the daemon will return an error if any of the tracks are not registered in the music library or if the list contains duplicates.

RemoveTracksFromPlaylist

Remove tracks from a playlist.

Fields

name: String

The name of the playlist to remove tracks from.

If a playlist with the specified name doesn’t exist in the music library, LibraryError::NoSuchPlaylist will be returned, and no changes to the music library will be made.

ids: Vec<usize>

The list of track indices in the playlist to remove.

Eg. to remove the first track you would pass [0], to remove the first three [0, 1, 2], etc.

If one or more of the indices is out of range, LibraryError::IndexOutOfBounds will be returned, and no changes to the music library will be made.

GetLibrary

Get the contents of the music library.

The daemon will respond to this with Response::Library if successful.

Rebuild

Reload the library and rebuild the cache ignoring already cached covers.

Will take more time than just reloading the cache.

Reload

Reload the library using cached data if possible.

This can be used to discover newly added tracks.

Trait Implementations

impl Clone for LibraryCommand

fn clone(&self) -> LibraryCommand

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LibraryCommand

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for LibraryCommand

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Hash for LibraryCommand

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LibraryCommand

fn eq(&self, other: &LibraryCommand) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for LibraryCommand

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for LibraryCommand

impl StructuralPartialEq for LibraryCommand