Skip to main content

StaffGroup

Struct StaffGroup 

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

Parts of a score bracketed together: music21’s layout.StaffGroup, which holds the parts it spans.

The parts are named by where they stand among the score’s parts, first to last, in the order the group was given them.

Implementations§

Source§

impl StaffGroup

Source

pub fn new(parts: Vec<usize>) -> Self

A group of the parts at these positions, barred together and drawn with no symbol, as music21’s starts out.

Source

pub fn parts(&self) -> &[usize]

The positions of the parts the group spans.

Source

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

The group’s name.

Source

pub fn set_name(&mut self, name: Option<String>)

Names the group, or clears the name.

Source

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

The group’s short name.

Source

pub fn set_abbreviation(&mut self, abbreviation: Option<String>)

Sets the short name, or clears it.

Source

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

What the group is drawn with: bracket, brace, line or square.

Source

pub fn set_symbol(&mut self, symbol: Option<&str>) -> Result<()>

Sets what the group is drawn with. As in music21, none in any case clears it, and anything but the four symbols is refused.

Source

pub fn bar_together(&self) -> Option<BarTogether>

How the group’s barlines are drawn, where that has been said.

Source

pub fn set_bar_together(&mut self, bar_together: Option<BarTogether>)

Says how the group’s barlines are drawn.

Source

pub fn name_hidden(&self) -> bool

Whether the name is left unprinted: music21’s hideObjectOnPrint.

Source

pub fn set_name_hidden(&mut self, hidden: bool)

Says whether the name is left unprinted.

Trait Implementations§

Source§

impl Clone for StaffGroup

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 StaffGroup

Source§

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

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

impl<'de> Deserialize<'de> for StaffGroup

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 StaffGroup

Source§

impl PartialEq for StaffGroup

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 StaffGroup

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 StaffGroup

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.