Struct mpris::Metadata

pub struct Metadata { /* private fields */ }

A structured representation of the Player metadata.

• Read more about the MPRIS2 Metadata_Map type.
• Read MPRIS v2 metadata guidelines

Implementations

impl Metadata

pub fn new<S>(track_id: S) -> Selfwhere S: Into<String>,

Create a new Metadata struct with a given track_id.

This is mostly useful for test fixtures and other places where you want to work with mock data.

pub fn get(&self, key: &str) -> Option<&Value>

Get a value from the metadata by key name.

Examples

if let Some(MetadataValue::String(name)) = metadata.get("xesam:composer") {
    println!("Composed by: {}", name);
}

pub fn track_id(&self) -> Option<TrackID>

The track ID.

If the TrackID could not be parsed as a proper TrackID, None will be returned.

Based on mpris:trackid

A unique identity for this track within the context of an MPRIS object.

pub fn album_artists(&self) -> Option<Vec<&str>>

A list of artists of the album the track appears on.

Based on xesam:albumArtist

The album artist(s).

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

The name of the album the track appears on.

Based on xesam:album

The album name.

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

An URL to album art of the current track.

Based on mpris:artUrl

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 artists(&self) -> Option<Vec<&str>>

A list of artists of the track.

Based on xesam:artist

The track artist(s).

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

Based on xesam:autoRating

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 disc_number(&self) -> Option<i32>

Based on xesam:discNumber

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

pub fn length_in_microseconds(&self) -> Option<u64>

The duration of the track, in microseconds

Based on mpris:length

The duration of the track in microseconds.

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

The duration of the track, as a Duration

Based on mpris:length.

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

The name of the track.

Based on xesam:title

The track title.

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

The track number on the disc of the album the track appears on.

Based on xesam:trackNumber

The track number on the album disc.

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

A URL to the media being played.

Based on xesam:url

The location of the media file.

pub fn as_hashmap(&self) -> HashMap<&str, &Value>

Returns an owned HashMap of borrowed values from this Metadata. Useful if you need a mutable hash but don’t have ownership of Metadata or want to consume it.

If you want to convert to a HashMap, use Into::into instead.

pub fn iter(&self) -> impl Iterator<Item = (&str, &Value)>

Iterate all metadata keys and values.

pub fn keys(&self) -> impl Iterator<Item = &str>

Iterate all metadata keys.

pub fn is_empty(&self) -> bool

Returns true if there is no metadata

Trait Implementations

impl Clone for Metadata

fn clone(&self) -> Metadata

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() -> Metadata

Returns the “default value” for a type.

impl From<HashMap<String, Value, RandomState>> for Metadata

fn from(values: HashMap<String, Value>) -> Self

Converts to this type from the input type.

impl From<Metadata> for HashMap<String, Value>

fn from(metadata: Metadata) -> Self

Converts to this type from the input type.

impl IntoIterator for Metadata

type Item = (String, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter<String, Value>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.