Struct melody::Song

pub struct Song {
    pub artist: Option<String>,
    pub album: Option<String>,
    pub title: Option<String>,
    pub track: Option<u32>,
    pub duration: Duration,
    pub genre: Option<String>,
    pub file: PathBuf,
    pub status: Status,
}

Song struct

Fields

artist: Option<String>

Artist of the song

album: Option<String>

Album of the song

title: Option<String>

Title of the song

track: Option<u32>

Track of the song

duration: Duration

Duration of the song

genre: Option<String>

Genre of the song

file: PathBuf

File path to the song

status: Status

Elapsed time of song playing or Start time

Methods

impl Song

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

Optionally return the artist of the song If None it wasn't able to read the tags

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

Optionally return the song's album If None failed to read the tags

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

Optionally return the title of the song If None it wasn't able to read the tags

pub fn track(&self) -> Option<u32>

Optionally returns the song's track number If None it wasn't able to read the tags

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

Optionally returns the song's genre If None it wasn't able to read the tags

pub fn duration(&self) -> Duration

Returns the Duration of the song

pub fn elapsed(&self) -> Duration

Returns the elapsed time the song has been played

pub fn stop(&mut self)

Pause the song

pub fn resume(&mut self)

Resume the song

pub fn is_stopped(&self) -> bool

Check if the song is stopped/paused

pub fn file(&self) -> &Path

Returns the path of the song

pub fn load(file: PathBuf) -> Result<Self, MelodyErrors>

Load song from Pathbuf

pub fn matching_song(&self, s: &Song, matching_genre: bool) -> bool

Checks if the song is the same if matching_genre is true it will check genre as well

pub fn exact_match(&self, s: &Song, same_path: bool) -> bool

Checks if the song is an exact match Checks the song's tags and if the path is the same

Trait Implementations

impl Eq for Song

impl Ord for Song

fn cmp(&self, other: &Song) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Song> for Song

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

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

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

This method tests for !=.

impl Clone for Song

fn clone(&self) -> Song

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Song> for Song

fn partial_cmp(&self, other: &Song) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Song) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Song) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Song) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Song) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl AsRef<Path> for Song

fn as_ref(&self) -> &Path

Performs the conversion.

impl Debug for Song

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

Formats the value using the given formatter.

impl Display for Song

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

Formats the value using the given formatter.