Struct Date 

pub struct Date { /* private fields */ }

A date as music21 keeps one: music21’s metadata.Date. Any part may be missing, and any part may say how sure it is.

use music21::metadata::primitives::{Certainty, Date, DatePart};

let read = Date::from_written("1030?/12~/?4")?;
assert_eq!(read.value(DatePart::Year), Some(1030));
assert_eq!(read.certainty(DatePart::Year), Some(Certainty::Uncertain));
assert_eq!(read.to_string(), "1030?/12~/04?");

Implementations

impl Date

pub fn new() -> Self

A date saying nothing at all.

pub fn value(&self, part: DatePart) -> Option<IntegerType>

The value of one part, where it has one.

pub fn certainty(&self, part: DatePart) -> Option<Certainty>

How sure one part is, where it says.

pub fn year(&self) -> Option<IntegerType>

The year, where the date gives one.

pub fn month(&self) -> Option<IntegerType>

The month, where the date gives one.

pub fn day(&self) -> Option<IntegerType>

The day, where the date gives one.

pub fn set( &mut self, part: DatePart, value: Option<IntegerType>, certainty: Option<Certainty>, ) -> Result<()>

Gives one part a value, with how sure it is.

Errors

A value no date can have – a thirteenth month, the thirty-first of April, the twenty-ninth of February in a year that is not a leap year. music21 checks the same, and leaves the value it was given in place when it raises, which is why Self::set_unchecked is here beside this.

pub fn set_unchecked( &mut self, part: DatePart, value: Option<IntegerType>, certainty: Option<Certainty>, )

Gives one part a value without asking whether a calendar has such a date: music21 writes its own attributes freely and only checks when a date is loaded, so a caller standing in for it writes this way and checks afterwards.

pub fn has_time(&self) -> bool

Whether any part of the time of day is given: music21’s hasTime.

pub fn has_certainty(&self) -> bool

Whether any part says how sure it is: music21’s hasError.

pub fn from_written(written: &str) -> Result<Self>

A date read from the way music21 writes one: music21’s loadStr. A part written -- says nothing; a symbol anywhere in a part says how sure it is. Colons are read as slashes, so 1834/12/4/4:50:32 and 1834/12/4:4:50:32 are one date.

Errors

A part that is not a number, or a value no date can have.

pub fn from_written_unchecked(written: &str) -> Result<Self>

A date read as Self::from_written reads one, without asking whether a calendar has such a date. music21’s own load keeps the values it read and then raises, so a caller standing in for it reads this way and calls Self::check afterwards.

Errors

A part that is not a number.

pub fn from_parts( year: Option<IntegerType>, month: Option<IntegerType>, day: Option<IntegerType>, ) -> Result<Self>

A date of a year, and of a month and a day where they are given.

Errors

A value no date can have.

pub fn take_from(&mut self, other: &Self) -> Result<()>

The parts of another date that it gives, written over this one’s, with their certainties: music21’s loadOther.

Errors

A value no date can have.

pub fn check(&self) -> Result<()>

Whether a calendar has such a date: music21’s _sanityCheck. It does not check whether a Gregorian leap year really was one, “as it changes historically”, and neither does this.

Errors

A value no date can have.

Trait Implementations

impl Clone for Date

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Date

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

Formats the value using the given formatter.

impl Default for Date

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Date

Available on crate feature serde only.

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Date

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

Formats the value using the given formatter.

impl Eq for Date

impl Hash for Date

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 PartialEq for Date

Two dates are equal where they are written alike, which is music21’s own __eq__ – it compares the two as strings.

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Date

Available on crate feature serde only.

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

where __S: Serializer,

Serialize this value into the given Serde serializer.