Struct Text 

pub struct Text { /* private fields */ }

One piece of text a score says about itself: music21’s metadata.Text. It keeps the language it is written in, whether it is a translation, and the scheme it was encoded by.

use music21::metadata::primitives::Text;

let title = Text::new("concerto in d").in_language("en");
assert_eq!(title.to_string(), "concerto in d");
assert_eq!(title.language(), Some("en"));

Implementations

impl Text

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

Some text, saying nothing else about itself.

pub fn data(&self) -> &str

The text itself.

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

The language it is written in, where it says.

pub fn is_translated(&self) -> Option<bool>

Whether it is a translation, where it says. Nothing at all means nobody has said.

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

The scheme it was encoded by, where it says.

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

The role it was given, which only music21’s Copyright has.

pub fn in_language(self, language: impl Into<String>) -> Self

The same text, said to be in a language.

pub fn translated(self, is_translated: bool) -> Self

The same text, said to be a translation or not.

pub fn encoded_by(self, scheme: impl Into<String>) -> Self

The same text, said to be encoded by a scheme.

pub fn in_role(self, role: impl Into<String>) -> Self

The same text, given a role: music21’s Copyright.

pub fn set_language(&mut self, language: Option<String>)

Says what language it is in.

pub fn set_translated(&mut self, is_translated: Option<bool>)

Says whether it is a translation.

pub fn set_encoding_scheme(&mut self, scheme: Option<String>)

Says what scheme it was encoded by.

pub fn set_role(&mut self, role: Option<String>)

Gives it a role.

pub fn normalized_article(&self) -> Result<String>

The text with the article put back at the front, where the language is one whose articles are moved: music21’s getNormalizedArticle, which is text::prepend_article.

Errors

A language whose articles are not known.

Trait Implementations

impl Clone for Text

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 Text

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

Formats the value using the given formatter.

impl Default for Text

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Text

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 Text

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

Formats the value using the given formatter.

impl Eq for Text

impl From<&str> for Text

fn from(data: &str) -> Self

Converts to this type from the input type.

impl From<String> for Text

fn from(data: String) -> Self

Converts to this type from the input type.

impl Hash for Text

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 Text

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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for Text

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Text

fn partial_cmp(&self, other: &Self) -> 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 Serialize for Text

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.

impl StructuralPartialEq for Text