Struct Note 

pub struct Note { /* private fields */ }

A pitched note.

Implementations

impl Note

pub fn from_name(name: impl Into<String>) -> Result<Self>

Builds a note from a pitch name such as "C#4" or "E-".

pub fn from_pitch(pitch: Pitch) -> Result<Self>

Builds a note from an existing Pitch.

pub fn pitch(&self) -> &Pitch

Returns the note’s pitch.

pub fn pitch_name(&self) -> String

Returns the pitch name without an octave, such as "C#" or "E-".

pub fn pitch_name_with_octave(&self) -> String

Returns the pitch name with an octave when one is set.

pub fn duration(&self) -> Option<&Duration>

Returns the note duration when one has been assigned.

pub fn set_duration(&mut self, duration: Duration)

Assigns a duration to the note.

pub fn with_duration(self, duration: Duration) -> Self

Returns a copy of this note with the supplied duration.

Trait Implementations

impl Clone for Note

fn clone(&self) -> Note

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Note

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Note

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Note

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

Formats the value using the given formatter.

impl From<Note> for StreamElement

fn from(value: Note) -> Self

Converts to this type from the input type.

impl FromStr for Note

type Err = Error

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl IntoNote for &Note

fn try_into_note(self) -> Result<Note>

Converts the value into a note.

const FROM_INTEGER_PITCH: bool = false

Whether this value came from an integer pitch class or MIDI-like number.

impl IntoNote for Note

fn try_into_note(self) -> Result<Note>

Converts the value into a note.

const FROM_INTEGER_PITCH: bool = false

Whether this value came from an integer pitch class or MIDI-like number.

impl Serialize for Note

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Pitch> for Note

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Pitch) -> Result<Self>

Performs the conversion.

impl TryFrom<&str> for Note

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self>

Performs the conversion.

impl TryFrom<Pitch> for Note

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Pitch) -> Result<Self>

Performs the conversion.

impl TryFrom<String> for Note

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self>

Performs the conversion.

impl TryFrom<i32> for Note

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: IntegerType) -> Result<Self>

Performs the conversion.