Struct Beams 

pub struct Beams { /* private fields */ }

The beams of one note, one for each level it is beamed at: music21’s beam.Beams.

Implementations

impl Beams

pub const LEVELS: usize

How many beams a written value carries, where it carries any: How many beams a written value can carry at the most: music21’s beamableDurationTypes, an eighth through a 2048th. It is how many depths a run of notes is beamed at.

pub fn new() -> Self

No beams at all.

pub fn beams(&self) -> &[Beam]

The beams, in level order.

pub fn len(&self) -> usize

How many levels are beamed.

pub fn is_empty(&self) -> bool

Whether the note carries no beam at all.

pub fn feathered(&self) -> bool

Whether the group is drawn fanned out.

pub fn set_feathered(&mut self, feathered: bool)

Draws the group fanned out, or stops doing so.

pub fn beams_mut(&mut self) -> &mut Vec<Beam>

The beams, to be edited in place.

pub fn set_beams(&mut self, beams: Vec<Beam>)

Replaces the beams outright.

pub fn append( &mut self, beam_type: impl Into<Option<BeamType>>, direction: Option<BeamDirection>, )

Adds a beam at the next level down: music21’s append.

pub fn levels_for(duration_type: DurationType) -> Option<u32>

music21’s beamableDurationTypes read as a count of levels.

pub fn fill( &mut self, duration_type: DurationType, beam_type: Option<BeamType>, ) -> Result<()>

Gives the note as many beams as its written value has, all of the same type: music21’s fill.

A value that carries no beam — anything a quarter or longer — is an error, as it is upstream.

pub fn fill_levels( &mut self, levels: u32, beam_type: Option<BeamType>, ) -> Result<()>

The same, counting the levels rather than naming the written value: music21 takes either, and fill(2) is a sixteenth.

The beams are left with nothing said about what they do, unless a type is given — music21 counts the lines first and decides them after.

pub fn set_all(&mut self, beam_type: BeamType, direction: Option<BeamDirection>)

Sets every beam to the same type: music21’s setAll.

pub fn by_number(&self, number: u32) -> Option<&Beam>

The beam at a level, counting from one: music21’s getByNumber.

pub fn set_by_number( &mut self, number: u32, beam_type: BeamType, direction: Option<BeamDirection>, ) -> Result<()>

Sets the beam at a level, which must already be there.

pub fn types(&self) -> Vec<Option<BeamType>>

The type of every beam, in level order: music21’s getTypes.

pub fn numbers(&self) -> Vec<Option<u32>>

The level of every beam: music21’s getNumbers.

Trait Implementations

impl Clone for Beams

fn clone(&self) -> Beams

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Beams

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

Formats the value using the given formatter.

impl Default for Beams

fn default() -> Beams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Beams

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 Beams

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

music21’s _reprInternal: every beam, slash-separated.

impl Eq for Beams

impl Hash for Beams

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 Beams

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Beams

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 Beams