Struct EntityRef

pub struct EntityRef {
    pub kind: EntityKind,
    pub key: String,
}

A stable way to name an entity, independent of any scan.

The key is what the thing calls itself rather than where it currently sits: a path for a track, the release key for an album, the normalized name for name-based entities. Recordings, works and release groups use an explicit MusicBrainz identifier when the catalog has one. Source-only artists and canonical credit exclusions may also use mbid:<identifier>.

Fields

kind: EntityKind

Which kind of thing is named.

key: String

Its stable key, in the spelling EntityRef builds.

Implementations

impl EntityRef

pub fn new(kind: EntityKind, key: impl Into<String>) -> EntityRef

Builds a reference by hand, for a key already in the right shape.

pub fn to_token(&self) -> String

How the reference is written in one token: track:/music/a.flac.

The kind comes first and the key may itself contain colons — a path does — so the split is on the first one only.

pub fn parse_token(text: &str) -> Option<EntityRef>

Reads back what EntityRef::to_token wrote.

pub fn of(catalog: &Catalog, kind: EntityKind, id: Id) -> Option<EntityRef>

The reference naming an entity of a catalog, if that entity exists.

pub fn resolve(&self, catalog: &Catalog) -> Option<Id>

The entity a reference names in this catalog, if it holds one.

pub fn display_name(&self, catalog: &Catalog) -> String

How the thing is called on screen, or the key when it is gone.

Trait Implementations

impl Clone for EntityRef

fn clone(&self) -> EntityRef

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EntityRef

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

Formats the value using the given formatter.

impl Default for EntityRef

fn default() -> EntityRef

Returns the “default value” for a type.

impl Ord for EntityRef

fn cmp(&self, other: &EntityRef) -> 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 PartialEq for EntityRef

fn eq(&self, other: &EntityRef) -> 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 EntityRef

fn partial_cmp(&self, other: &EntityRef) -> 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 Eq for EntityRef

impl StructuralPartialEq for EntityRef