mpris-server 0.10.0

use serde::Serialize;
use zbus::zvariant::{ObjectPath, Type, Value};

use crate::{PlaylistId, Uri};

/// A data structure describing a playlist.
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Type)]
pub struct Playlist {
    /// A unique identifier for the playlist.
    ///
    /// This should remain the same if the playlist is renamed.
    pub id: PlaylistId,
    /// The name of the playlist, typically given by the user.
    pub name: String,
    /// The URI of an (optional) icon.
    pub icon: Uri,
}

impl From<Playlist> for Value<'_> {
    fn from(p: Playlist) -> Self {
        Value::from((p.id, p.name, p.icon))
    }
}

/// A data structure describing a playlist, or nothing.
///
/// <details><summary>Rationale</summary>
///
/// D-Bus does not (at the time of writing) support a MAYBE type, so we are
/// forced to invent our own.
///
/// </details>
#[derive(Debug, Clone, PartialEq, Eq, Serialize, Type)]
#[doc(alias = "Maybe_Playlist")]
pub(crate) struct MaybePlaylist {
    /// Whether this structure refers to a valid playlist.
    valid: bool,
    /// The playlist, providing `valid` is true, otherwise undefined.
    ///
    /// When constructing this type, it should be noted that the playlist ID
    /// must be a valid object path, or D-Bus implementations may reject it.
    /// This is true even when Valid is false. It is suggested that "/" is
    /// used as the playlist ID in this case.
    playlist: Playlist,
}

impl From<Option<Playlist>> for MaybePlaylist {
    fn from(playlist: Option<Playlist>) -> Self {
        match playlist {
            Some(playlist) => Self {
                valid: true,
                playlist,
            },
            None => Self {
                valid: false,
                playlist: Playlist {
                    id: ObjectPath::from_static_str_unchecked("/").into(),
                    name: String::new(),
                    icon: Uri::new(),
                },
            },
        }
    }
}

impl From<MaybePlaylist> for Value<'_> {
    fn from(mp: MaybePlaylist) -> Self {
        Value::from((mp.valid, mp.playlist))
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn valid_signatures() {
        assert_eq!(Playlist::SIGNATURE, "(oss)");
        assert_eq!(MaybePlaylist::SIGNATURE, "(b(oss))");
    }
}