Skip to main content

MetadataValue

Struct MetadataValue 

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

One value of a metadata name: its text and, for a contributor or a copyright, the role it was given – and the primitive it is, which says what more is known about it.

The text and the role are a reading of the content, not a second copy of it. Every way of building one of these fills all three together and nothing can write to them afterwards, so they cannot drift apart: a contributor’s text is the first name they go by, and a date’s is the way music21 writes it.

A value built as a plain text is not equal to one built as a contributor or a date of the same text, and that is right: the one knows what it is and the other does not.

Implementations§

Source§

impl MetadataValue

Source

pub fn new(text: impl Into<String>) -> Self

A value that is only text.

Source

pub fn with_role(text: impl Into<String>, role: impl Into<String>) -> Self

A value with a role, as a contributor or a copyright has.

Source

pub fn of_text(text: Text) -> Self

A value that is a piece of text saying what language it is in: music21’s Text, or its Copyright where the text has a role.

Source

pub fn of_contributor(contributor: Contributor) -> Self

A value that is somebody who had a hand in the work: music21’s Contributor. Its text is the first name they go by, which is what music21’s own writers write.

Source

pub fn of_date(date: DatePrimitive) -> Self

A value that is a date: music21’s four date classes. Its text is the way music21 writes that date.

Source

pub fn text(&self) -> &str

The value as text: music21’s str(value).

Source

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

The role, where the value has one.

Source

pub fn content(&self) -> &MetadataContent

What the value is: a text, a contributor or a date.

Source

pub fn as_text(&self) -> Option<&Text>

The text with its language, where the value is one.

Source

pub fn as_contributor(&self) -> Option<&Contributor>

The contributor, where the value is one.

Source

pub fn as_date(&self) -> Option<&DatePrimitive>

The date, where the value is one.

Trait Implementations§

Source§

impl Clone for MetadataValue

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MetadataValue

Source§

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

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

impl<'de> Deserialize<'de> for MetadataValue

Available on crate feature serde only.
Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Eq for MetadataValue

Source§

impl PartialEq for MetadataValue

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for MetadataValue

Available on crate feature serde only.
Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for MetadataValue

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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 = !

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

fn try_from(value: U) -> Result<T, !>

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.