Scrobble

Struct Scrobble 

Source
pub struct Scrobble { /* private fields */ }
Expand description

Repesents a single music track played at a point in time. In the Last.fm universe, this is known as a “scrobble”.

Takes an artist, track and album name. Can hold a timestamp indicating when the track was listened to. Scrobble objects are submitted via Scrobbler::now_playing, Scrobbler::scrobble and batches of Scrobbles are sent via Scrobbler::scrobble_batch.

Implementations§

Source§

impl Scrobble

Source

pub fn new(artist: &str, track: &str, album: &str) -> Self

Constructs a new Scrobble instance, representing a single playthrough of a music track. Scrobbles are submitted to Last.fm via an instance of Scrobbler. A new Scrobble requires an artist name, song/track name, and an album name.

§Example
let scrobble = Scrobble::new("Example Artist", "Example Track", "Example Album")
Source

pub fn with_timestamp(&mut self, timestamp: u64) -> &mut Self

Sets the timestamp (date/time of play) of a Scrobble. Used in a builder-style pattern, typically after Scrobble::new.

§Example
let mut scrobble = Scrobble::new(...).with_timestamp(12345);
§Note on Timestamps

Scrobbles without timestamps are automatically assigned a timestamp of the current time when submitted via Scrobbler::scrobble or Scrobbler::scrobble_batch. Timestamps only need to be explicitly set when you are submitting a Scrobble at a point in the past, or in the future.

Source

pub fn as_map(&self) -> HashMap<String, String>

Converts the Scrobble metadata (track name, artist & album name) into a HashMap. Map keys are "track", "artist" and "album". If a timestamp is set, it will be present in the map under key "timestamp".

§Example
let scrobble = Scrobble::new("Example Artist", ...);
let scrobble_map = scrobble.as_map();
assert_eq!(scrobble_map.get("artist"), "Example Artist");
Source

pub fn artist(&self) -> &str

Returns the Scrobble’s artist name

Source

pub fn track(&self) -> &str

Returns the Scrobble’s track name

Source

pub fn album(&self) -> &str

Returns the Scrobble’s album name

Trait Implementations§

Source§

impl Clone for Scrobble

Source§

fn clone(&self) -> Scrobble

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Scrobble

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Extend<Scrobble> for ScrobbleBatch

Source§

fn extend<T: IntoIterator<Item = Scrobble>>(&mut self, iter: T)

Extends a collection with the contents of an iterator. Read more
Source§

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)
Extends a collection with exactly one element.
Source§

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)
Reserves capacity in a collection for the given number of additional elements. Read more
Source§

impl From<&(&str, &str, &str)> for Scrobble

Converts from tuple of &strs in the form (artist, track, album)

Designed to make it easier to cooperate with other track info types.

Source§

fn from((artist, track, album): &(&str, &str, &str)) -> Self

Converts to this type from the input type.
Source§

impl From<&(String, String, String)> for Scrobble

Converts from tuple of Strings in the form (artist, track, album)

Designed to make it easier to cooperate with other track info types.

Source§

fn from((artist, track, album): &(String, String, String)) -> Self

Converts to this type from the input type.
Source§

impl FromIterator<Scrobble> for ScrobbleBatch

Source§

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

Creates a value from an iterator. Read more
Source§

impl Hash for Scrobble

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl Ord for Scrobble

Source§

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

This method returns an Ordering between self and other. Read more
1.21.0 · Source§

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

Compares and returns the maximum of two values. Read more
1.21.0 · Source§

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

Compares and returns the minimum of two values. Read more
1.50.0 · Source§

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

Restrict a value to a certain interval. Read more
Source§

impl PartialEq for Scrobble

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl PartialOrd for Scrobble

Source§

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

This method returns an ordering between self and other values if one exists. Read more
1.0.0 · Source§

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

Tests less than (for self and other) and is used by the < operator. Read more
1.0.0 · Source§

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

Tests less than or equal to (for self and other) and is used by the <= operator. Read more
1.0.0 · Source§

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

Tests greater than (for self and other) and is used by the > operator. Read more
1.0.0 · Source§

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

Tests greater than or equal to (for self and other) and is used by the >= operator. Read more
Source§

impl Eq for Scrobble

Source§

impl StructuralPartialEq for Scrobble

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.