Skip to main content

RepeatExpression

Struct RepeatExpression 

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

A word or sign telling a player where to go next: music21’s RepeatExpression.

use music21_rs::repeat::{RepeatExpression, RepeatExpressionKind};

let fine = RepeatExpression::new(RepeatExpressionKind::Fine);
assert_eq!(fine.text(), "fine");
assert!(!fine.use_symbol());

let coda = RepeatExpression::with_text(RepeatExpressionKind::Coda, "to Coda");
assert_eq!(coda.text(), "to Coda");
assert!(!coda.use_symbol());

Implementations§

Source§

impl RepeatExpression

Source

pub fn new(kind: RepeatExpressionKind) -> Self

A mark of a kind, written as music21 writes it when nothing says otherwise: a coda and a segno as their signs, everything else in words.

Source

pub fn with_text(kind: RepeatExpressionKind, text: &str) -> Self

A mark of a kind written in these words, where they are one of its ways of being written, and as it is written by default otherwise: music21’s text argument. A coda given words is written in them rather than as its sign. A segno and fine are always written their own way.

Source

pub fn kind(&self) -> RepeatExpressionKind

Which kind of mark this is.

Source

pub fn text(&self) -> &str

The words the mark is written in: music21’s getText.

Source

pub fn set_text(&mut self, text: impl Into<String>)

Writes the mark in other words, whatever they are: music21’s setText.

Source

pub fn is_valid_text(&self, text: &str) -> bool

Whether these words are one of the ways this kind of mark is written, ignoring case, spaces and full stops: music21’s isValidText.

Source

pub fn use_symbol(&self) -> bool

Whether the mark is drawn as its sign rather than in words.

Source

pub fn set_use_symbol(&mut self, use_symbol: bool)

Says whether the mark is drawn as its sign. Only a coda and a segno have one to draw.

Source

pub fn placement(&self) -> Option<Placement>

Which side of the staff the words are written on, where a score says.

Source

pub fn set_placement(&mut self, placement: Option<Placement>)

Says which side of the staff the words are written on.

Trait Implementations§

Source§

impl Clone for RepeatExpression

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 RepeatExpression

Source§

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

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

impl<'de> Deserialize<'de> for RepeatExpression

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 RepeatExpression

Source§

impl From<RepeatExpression> for StreamElement

Source§

fn from(value: RepeatExpression) -> Self

Converts to this type from the input type.
Source§

impl Hash for RepeatExpression

Source§

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for RepeatExpression

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 RepeatExpression

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 RepeatExpression

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.