Struct mpris::TrackID

pub struct TrackID(_);

Represents the MPRIS Track_Id type.

use mpris::TrackID;
let no_track = TrackID::new("/org/mpris/MediaPlayer2/TrackList/NoTrack").unwrap();

TrackIDs must be valid D-Bus object paths according to the spec.

Errors

Trying to construct a TrackID from a string that is not a valid D-Bus Path will fail.

let result = TrackID::new("invalid track ID");
assert!(result.is_err());

Implementations

impl TrackID

pub fn new<S: Into<String>>(id: S) -> Result<Self, String>

Create a new TrackID from a string-like entity.

This is not something you should normally do as the IDs are temporary and will only work if the Player knows about it.

However, creating TrackIDs manually can help with test setup, comparisons, etc.

Example

use mpris::TrackID;
let id = TrackID::new("/dbus/path/id").expect("Parse error");

pub fn no_track() -> Self

Return a new TrackID that matches the MPRIS standard for the “No track” sentinel value.

Some APIs takes this in order to signal a missing value for a track, for example by saying that no specific track is playing, or that a track should be added at the start of the list instead of after a specific track.

The actual path is “/org/mpris/MediaPlayer2/TrackList/NoTrack”.

This value is only valid in some cases. Make sure to read the MPRIS specification before you use this manually.

pub fn as_str(&self) -> &str

Returns a &str variant of the ID.

Trait Implementations

impl AsRef<str> for TrackID

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for TrackID

fn clone(&self) -> TrackID

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TrackID

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

Formats the value using the given formatter.

impl Display for TrackID

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

Formats the value using the given formatter.

impl<'a> From<&'a TrackID> for Path<'a>

fn from(id: &'a TrackID) -> Path<'a>

Converts to this type from the input type.

impl<'a> From<&'a TrackID> for TrackID

fn from(id: &'a TrackID) -> Self

Converts to this type from the input type.

impl<'a> From<Path<'a>> for TrackID

fn from(path: Path<'a>) -> TrackID

Converts to this type from the input type.

impl From<TrackID> for String

fn from(id: TrackID) -> String

Converts to this type from the input type.

impl FromIterator<TrackID> for TrackList

fn from_iter<I: IntoIterator<Item = TrackID>>(iter: I) -> Self

Creates a value from an iterator.

impl Hash for TrackID

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<TrackID> for TrackID

fn eq(&self, other: &TrackID) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for TrackID

impl StructuralEq for TrackID

impl StructuralPartialEq for TrackID