mpris_server/
playlist_ordering.rs

1use std::fmt;
2
3use serde::Deserialize;
4use zbus::zvariant::{Type, Value};
5
6/// Specifies the ordering of returned playlists.
7///
8/// <details><summary>Rationale</summary>
9///
10/// Some media players may allow users to order playlists
11/// as they wish. This ordering allows playlists to be retrieved
12/// in that order.
13///
14/// </details>
15#[derive(Debug, Clone, Copy, PartialEq, Eq, Deserialize, Type)]
16#[zvariant(signature = "s")]
17#[doc(alias = "Playlist_Ordering")]
18pub enum PlaylistOrdering {
19    /// Alphabetical ordering by name, ascending.
20    #[serde(rename = "Alphabetical")]
21    Alphabetical,
22    /// Ordering by creation date, oldest first.
23    #[serde(rename = "Created")]
24    CreationDate,
25    /// Ordering by last modified date, oldest first.
26    #[serde(rename = "Modified")]
27    ModifiedDate,
28    /// Ordering by date of last playback, oldest first.
29    #[serde(rename = "Played")]
30    LastPlayDate,
31    /// A user-defined ordering.
32    #[serde(rename = "User")]
33    UserDefined,
34}
35
36impl PlaylistOrdering {
37    /// Returns the string representation of this playlist ordering.
38    pub fn as_str(&self) -> &'static str {
39        match self {
40            Self::Alphabetical => "Alphabetical",
41            Self::CreationDate => "Created",
42            Self::ModifiedDate => "Modified",
43            Self::LastPlayDate => "Played",
44            Self::UserDefined => "User",
45        }
46    }
47}
48
49impl fmt::Display for PlaylistOrdering {
50    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
51        f.write_str(self.as_str())
52    }
53}
54
55impl From<PlaylistOrdering> for Value<'_> {
56    fn from(status: PlaylistOrdering) -> Self {
57        Value::new(status.as_str())
58    }
59}