Struct mpris_server::Metadata

pub struct Metadata(/* private fields */);

A mapping from metadata attribute names to values.

The mpris:trackid attribute must always be present.

If the length of the track is known, it should be provided in the metadata property with the mpris:length key.

If there is an image associated with the track, a URL for it may be provided using the mpris:artUrl key.

Implementations

impl Metadata

pub fn new() -> Self

Creates an empty Metadata.

pub fn builder() -> MetadataBuilder

Creates a new builder-pattern struct instance to construct Metadata.

pub fn get<'v, V>(&'v self, key: &str) -> Option<Result<&'v V>>

where &'v V: TryFrom<&'v Value<'v>>, <&'v V as TryFrom<&'v Value<'v>>>::Error: Into<Error>,

Returns the value corresponding to the key and convert it to V.

pub fn get_value(&self, key: &str) -> Option<&Value<'_>>

Returns a reference to the value corresponding to the key.

pub fn set( &mut self, key: &str, value: Option<impl Into<Value<'static>>>, ) -> Option<Value<'static>>

Replaces the value for the given key and returns the previous value, if any.

The entry is removed if the given value is None.

pub fn set_value( &mut self, key: &str, value: Option<Value<'static>>, ) -> Option<Value<'static>>

Replaces the value for the given key and returns the previous value, if any.

The entry is removed if the given value is None.

This behaves like Metadata::set, but this takes a [enum@Value] instead of a generic type.

pub fn trackid(&self) -> Option<TrackId>

A unique identity for this track within the context of an MPRIS object (eg: tracklist).

This contains a D-Bus path that uniquely identifies the track within the scope of the playlist. There may or may not be an actual D-Bus object at that path; this specification says nothing about what interfaces such an object may implement.

pub fn set_trackid(&mut self, trackid: Option<impl Into<TrackId>>)

Sets a unique identity for this track within the context of an MPRIS object (eg: tracklist).

This contains a D-Bus path that uniquely identifies the track within the scope of the playlist. There may or may not be an actual D-Bus object at that path; this specification says nothing about what interfaces such an object may implement.

pub fn length(&self) -> Option<Time>

The duration of the track.

pub fn set_length(&mut self, length: Option<Time>)

Sets the duration of the track.

pub fn art_url(&self) -> Option<Uri>

The location of an image representing the track or album.

Clients should not assume this will continue to exist when the media player stops giving out the URL.

pub fn set_art_url(&mut self, art_url: Option<impl Into<Uri>>)

Sets the location of an image representing the track or album.

Clients should not assume this will continue to exist when the media player stops giving out the URL.

pub fn album(&self) -> Option<&str>

The album name.

pub fn set_album(&mut self, album: Option<impl Into<String>>)

Sets the album name.

pub fn album_artist(&self) -> Option<Vec<String>>

The album artist(s).

pub fn set_album_artist( &mut self, album_artist: Option<impl IntoIterator<Item = impl Into<String>>>, )

Sets the album artist(s).

pub fn artist(&self) -> Option<Vec<String>>

The track artist(s).

pub fn set_artist( &mut self, artist: Option<impl IntoIterator<Item = impl Into<String>>>, )

Sets the track artist(s).

pub fn lyrics(&self) -> Option<&str>

The track lyrics.

pub fn set_lyrics(&mut self, lyrics: Option<impl Into<String>>)

Sets the track lyrics.

pub fn audio_bpm(&self) -> Option<i32>

The speed of the music, in beats per minute.

pub fn set_audio_bpm(&mut self, audio_bpm: Option<i32>)

Sets the speed of the music, in beats per minute.

pub fn auto_rating(&self) -> Option<f64>

An automatically-generated rating, based on things such as how often it has been played. This should be in the range 0.0 to 1.0.

pub fn set_auto_rating(&mut self, auto_rating: Option<f64>)

Sets an automatically-generated rating, based on things such as how often it has been played. This should be in the range 0.0 to 1.0.

pub fn comment(&self) -> Option<Vec<String>>

A (list of) freeform comment(s).

pub fn set_comment( &mut self, comment: Option<impl IntoIterator<Item = impl Into<String>>>, )

Sets a (list of) freeform comment(s).

pub fn composer(&self) -> Option<Vec<String>>

The composer(s) of the track.

pub fn set_composer( &mut self, composer: Option<impl IntoIterator<Item = impl Into<String>>>, )

Sets the composer(s) of the track.

pub fn content_created(&self) -> Option<DateTime>

When the track was created. Usually only the year component will be useful.

pub fn set_content_created( &mut self, content_created: Option<impl Into<DateTime>>, )

Sets when the track was created. Usually only the year component will be useful.

pub fn disc_number(&self) -> Option<i32>

The disc number on the album that this track is from.

pub fn set_disc_number(&mut self, disc_number: Option<i32>)

Sets the disc number on the album that this track is from.

pub fn first_used(&self) -> Option<DateTime>

When the track was first played.

pub fn set_first_used(&mut self, first_used: Option<impl Into<DateTime>>)

Sets when the track was first played.

pub fn genre(&self) -> Option<Vec<String>>

The genre(s) of the track.

pub fn set_genre( &mut self, genre: Option<impl IntoIterator<Item = impl Into<String>>>, )

Sets the genre(s) of the track.

pub fn last_used(&self) -> Option<DateTime>

When the track was last played.

pub fn set_last_used(&mut self, last_used: Option<impl Into<DateTime>>)

Sets when the track was last played.

pub fn lyricist(&self) -> Option<Vec<String>>

The lyricist(s) of the track.

pub fn set_lyricist( &mut self, lyricist: Option<impl IntoIterator<Item = impl Into<String>>>, )

Sets the lyricist(s) of the track.

pub fn title(&self) -> Option<&str>

The track title.

pub fn set_title(&mut self, title: Option<impl Into<String>>)

Sets the track title.

pub fn track_number(&self) -> Option<i32>

The track number on the album disc.

pub fn set_track_number(&mut self, track_number: Option<i32>)

Sets the track number on the album disc.

pub fn url(&self) -> Option<Uri>

The location of the media file.

pub fn set_url(&mut self, url: Option<impl Into<Uri>>)

Sets the location of the media file.

pub fn use_count(&self) -> Option<i32>

The number of times the track has been played.

pub fn set_use_count(&mut self, use_count: Option<i32>)

Sets the number of times the track has been played.

pub fn user_rating(&self) -> Option<f64>

A user-specified rating. This should be in the range 0.0 to 1.0.

pub fn set_user_rating(&mut self, user_rating: Option<f64>)

Sets a user-specified rating. This should be in the range 0.0 to 1.0.

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Metadata

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

Formats the value using the given formatter.

impl Default for Metadata

fn default() -> Self

Returns the “default value” for a type.

impl<'a> From<Metadata> for Value<'a>

fn from(metainfo: Metadata) -> Self

Converts to this type from the input type.

impl PartialEq for Metadata

fn eq(&self, other: &Metadata) -> 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 Metadata

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Type for Metadata

fn signature() -> Signature<'static>

Get the signature for the implementing type.

impl StructuralPartialEq for Metadata