Struct bliss_audio::Song

pub struct Song {
    pub path: String,
    pub artist: String,
    pub title: String,
    pub album: String,
    pub track_number: String,
    pub genre: String,
    pub analysis: Analysis,
}

Simple object used to represent a Song, with its path, analysis, and other metadata (artist, genre…)

Fields

path: String

Song’s provided file path

artist: String

Song’s artist, read from the metadata ("" if empty)

title: String

Song’s title, read from the metadata ("" if empty)

album: String

Song’s album name, read from the metadata ("" if empty)

track_number: String

Song’s tracked number, read from the metadata ("" if empty)

genre: String

Song’s genre, read from the metadata ("" if empty)

analysis: Analysis

bliss analysis results

Implementations

impl Song

pub fn distance(&self, other: &Self) -> f32

Compute the distance between the current song and any given Song.

The smaller the number, the closer the songs; usually more useful if compared between several songs (e.g. if song1.distance(song2) < song1.distance(song3), then song1 is closer to song2 than it is to song3.

pub fn new(path: &str) -> Result<Self, BlissError>

Returns a decoded Song given a file path, or an error if the song could not be analyzed for some reason.

Arguments

• path - A string holding a valid file path to a valid audio file.

Errors

This function will return an error if the file path is invalid, if the file path points to a file containing no or corrupted audio stream, or if the analysis could not be conducted to the end for some reason.

The error type returned should give a hint as to whether it was a decoding (DecodingError) or an analysis (AnalysisError) error.

Trait Implementations

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 Debug for Song

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

Formats the value using the given formatter.

impl Default for Song

fn default() -> Song

Returns the “default value” for a type.

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 StructuralPartialEq for Song