Enum Tag

#[non_exhaustive]
pub enum Tag {
    Album,
    AlbumArtist,
    AlbumArtistSort,
    AlbumSort,
    Artist,
    ArtistSort,
    Comment,
    Composer,
    ComposerSort,
    Conductor,
    Date,
    Disc,
    Ensemble,
    Genre,
    Grouping,
    Label,
    Location,
    Movement,
    MovementNumber,
    MusicBrainzArtistId,
    MusicBrainzRecordingId,
    MusicBrainzReleaseArtistId,
    MusicBrainzReleaseId,
    MusicBrainzTrackId,
    MusicBrainzWorkId,
    Name,
    OriginalDate,
    Performer,
    Title,
    Track,
    Work,
    Other(Box<str>),
}

Tags which can be set on a Song.

MusicBrainz tags are named differently from how they appear in the protocol to better reflect their actual purpose.

Tag validity

Manually constructing a tag with the Other variant may result in protocols errors if the tag is invalid. Use the TryFrom implementation for checked conversion.

Unknown tags

When parsing or constructing responses, tags not recognized by this type will be stored as they are encountered using the Other variant. Additionally the enum is marked as non-exhaustive, so additional tags may be added without breaking compatibility.

The equality is checked using the string representation, so Other variants are forward-compatible with new variants being added.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Album

AlbumArtist

AlbumArtistSort

AlbumSort

Artist

ArtistSort

Comment

Composer

ComposerSort

Conductor

Date

Disc

Ensemble

Genre

Grouping

Label

Location

Movement

MovementNumber

MusicBrainzArtistId

MusicBrainzRecordingId

MusicBrainzReleaseArtistId

MusicBrainzReleaseId

MusicBrainzTrackId

MusicBrainzWorkId

Name

OriginalDate

Performer

Title

Track

Work

Other(Box<str>)

Catch-all variant that contains the raw tag string when it doesn’t match any other variants, but is valid.

Implementations

impl Tag

pub fn any() -> Self

Creates a tag for filtering which will match any tag.

Trait Implementations

impl Argument for Tag

fn render(&self, buf: &mut BytesMut)

Render the argument into the command buffer.

impl Clone for Tag

fn clone(&self) -> Tag

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Tag

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

Formats the value using the given formatter.

impl Hash for Tag

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 Ord for Tag

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<'a> PartialEq<&'a str> for Tag

fn eq(&self, other: &&'a str) -> bool

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialEq for Tag

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for Tag

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a> TryFrom<&'a str> for Tag

type Error = TagError

The type returned in the event of a conversion error.

fn try_from(raw: &'a str) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for Tag