Skip to content

misc: add default method impls #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SeaDve wants to merge 1 commit into
base: main
Choose a base branch
from
Open

misc: add default method impls #8

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 30 additions & 9 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
// * Document the rest of public interface
// * Access Server from interfaces
// * Replace `DateTime` and `Uri` with proper types
// * Add sensible default method impls on `*Interface` traits
// * Profile if inlining is worth it
// * Add public `test` method to check if interface is implemented correctly
// * Avoid clones in `Metadata` getters
Expand Down Expand Up @@ -85,6 +84,12 @@ pub use crate::{
track_id::TrackId,
};

macro_rules! unknown_property_err {
($prop_name:literal) => {
fdo::Error::UnknownProperty(concat!($prop_name, " is not supported").into())
};
}

macro_rules! define_iface {
(#[$attr:meta],
$root_iface_ident:ident$(: $bound:tt $(+ $other_bounds:tt)* )? extra_docs $extra_root_docs:literal,
Expand Down Expand Up @@ -178,15 +183,19 @@ macro_rules! define_iface {
/// [`properties_changed`]: Server::properties_changed
/// [`CanSetFullscreen`]: Self::can_set_fullscreen
#[doc(alias = "Fullscreen")]
async fn fullscreen(&self) -> fdo::Result<bool>;
async fn fullscreen(&self) -> fdo::Result<bool> {
Err(unknown_property_err!("Fullscreen"))
}

/// Sets whether the media player is occupying the fullscreen.
///
/// See [`Fullscreen`] for more details.
///
/// [`Fullscreen`]: Self::fullscreen
#[doc(alias = "Fullscreen")]
async fn set_fullscreen(&self, fullscreen: bool) -> Result<()>;
async fn set_fullscreen(&self, _fullscreen: bool) -> Result<()> {
Err(zbus::Error::from(unknown_property_err!("Fullscreen")))
}

/// Whether the player may be asked to enter or leave fullscreen.
///
Expand Down Expand Up @@ -218,7 +227,9 @@ macro_rules! define_iface {
/// [`properties_changed`]: Server::properties_changed
/// [`Fullscreen`]: Self::fullscreen
#[doc(alias = "CanSetFullscreen")]
async fn can_set_fullscreen(&self) -> fdo::Result<bool>;
async fn can_set_fullscreen(&self) -> fdo::Result<bool> {
Err(unknown_property_err!("CanSetFullscreen"))
}

/// Whether the media player may be asked to be raised.
///
Expand Down Expand Up @@ -279,7 +290,9 @@ macro_rules! define_iface {
/// [Desktop entry specification]: https://specifications.freedesktop.org/desktop-entry-spec/latest/
/// [`properties_changed`]: Server::properties_changed
#[doc(alias = "DesktopEntry")]
async fn desktop_entry(&self) -> fdo::Result<String>;
async fn desktop_entry(&self) -> fdo::Result<String> {
Err(unknown_property_err!("DesktopEntry"))
}

/// The URI schemes supported by the media player.
///
Expand Down Expand Up @@ -548,15 +561,19 @@ macro_rules! define_iface {
/// [`Playlist`]: LoopStatus::Playlist
/// [`CanControl`]: Self::can_control
#[doc(alias = "LoopStatus")]
async fn loop_status(&self) -> fdo::Result<LoopStatus>;
async fn loop_status(&self) -> fdo::Result<LoopStatus> {
Err(unknown_property_err!("LoopStatus"))
}

/// Sets the current loop / repeat status
///
/// See [`LoopStatus`] for more details.
///
/// [`LoopStatus`]: Self::loop_status
#[doc(alias = "LoopStatus")]
async fn set_loop_status(&self, loop_status: LoopStatus) -> Result<()>;
async fn set_loop_status(&self, _loop_status: LoopStatus) -> Result<()> {
Err(zbus::Error::from(unknown_property_err!("LoopStatus")))
}

/// The current playback rate.
///
Expand Down Expand Up @@ -624,15 +641,19 @@ macro_rules! define_iface {
/// [`properties_changed`]: Server::properties_changed
/// [`CanControl`]: Self::can_control
#[doc(alias = "Shuffle")]
async fn shuffle(&self) -> fdo::Result<bool>;
async fn shuffle(&self) -> fdo::Result<bool> {
Err(unknown_property_err!("Shuffle"))
}

/// Sets whether playback is shuffled.
///
/// See [`Shuffle`] for more details.
///
/// [`Shuffle`]: Self::shuffle
#[doc(alias = "Shuffle")]
async fn set_shuffle(&self, shuffle: bool) -> Result<()>;
async fn set_shuffle(&self, _shuffle: bool) -> Result<()> {
Err(zbus::Error::from(unknown_property_err!("Shuffle")))
}

/// The metadata of the current element.
///
Expand Down