Skip to main content

MusicXmlWriteOptions

Struct MusicXmlWriteOptions 

Source
pub struct MusicXmlWriteOptions {
    pub beams: bool,
    pub tuplet_display: TupletDisplay,
    pub stems: bool,
    pub rest_placement: bool,
    pub slur_placement: bool,
    pub tie_orientation: bool,
}
Expand description

Opt-in engraving hints the MusicXML writer computes at write time from data the score already holds (meter, durations, clef, voice). Every field defaults off, so MusicXmlWriteOptions::default reproduces the writer’s byte-for-byte round-trip output; the reader self-loop and the abc2xml whitelist depend on that default.

The rules are croma’s own, written from published engraving references; see docs/engraving-export.md and docs/engraving/rules.md.

Fields§

§beams: bool

Emit <beam> grouping computed from meter + note durations.

§tuplet_display: TupletDisplay

How to spell <tuplet> display detail when the source carried no directive.

§stems: bool

Emit <stem>up|down computed from clef, pitch, voice, and beam membership.

§rest_placement: bool

Emit multi-voice rest <display-step>/<display-octave> so voices do not collide.

§slur_placement: bool

Emit <slur placement="above|below"> computed from stem direction / voice.

§tie_orientation: bool

Emit <tied orientation="over|under"> computed from stem direction / voice.

Implementations§

Source§

impl MusicXmlWriteOptions

Source

pub fn engrave() -> Self

The --engrave umbrella: every hint on, tuplet display = engraving default.

Source

pub fn any_enabled(self) -> bool

Whether any hint is enabled (lets the writer skip plan construction entirely on the default path).

Trait Implementations§

Source§

impl Clone for MusicXmlWriteOptions

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 Copy for MusicXmlWriteOptions

Source§

impl Debug for MusicXmlWriteOptions

Source§

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

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

impl Default for MusicXmlWriteOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for MusicXmlWriteOptions

Source§

impl PartialEq for MusicXmlWriteOptions

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 StructuralPartialEq for MusicXmlWriteOptions

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> 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> 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.