Skip to main content

PublicationConfig

Struct PublicationConfig 

Source
pub struct PublicationConfig {
Show 17 fields pub title_page: bool, pub running_title: Option<String>, pub show_part_names: bool, pub show_measure_numbers: bool, pub header_text: Option<String>, pub footer_text: Option<String>, pub header_template: PublicationPageTemplate, pub footer_template: PublicationPageTemplate, pub page_number_in_footer: bool, pub header_alignment: PublicationTextAlignment, pub footer_alignment: PublicationTextAlignment, pub title_alignment: PublicationTextAlignment, pub line_height_mm: f32, pub image_resources: Vec<PublicationImageResource>, pub sections: Vec<PublicationSection>, pub spacers: Vec<PublicationSpacer>, pub frames: Vec<PublicationFrame>,
}
Expand description

Host-neutral publication metadata policy carried into each page artifact.

Fields§

§title_page: bool

Insert a metadata-only title page before the music pages.

§running_title: Option<String>

Optional running title shown by a host on non-title pages.

§show_part_names: bool§show_measure_numbers: bool§header_text: Option<String>

Optional text placed in the logical page header.

§footer_text: Option<String>

Optional text placed in the logical page footer.

§header_template: PublicationPageTemplate

Odd/even header text. When configured, this supersedes header_text and running_title.

§footer_template: PublicationPageTemplate

Odd/even footer text. When configured, this supersedes footer_text.

§page_number_in_footer: bool

Add the logical page number as a footer text block when numbering is enabled.

§header_alignment: PublicationTextAlignment§footer_alignment: PublicationTextAlignment§title_alignment: PublicationTextAlignment§line_height_mm: f32

Logical line-box height for publication text blocks, in millimetres.

§image_resources: Vec<PublicationImageResource>

Host-resolved publication images carried as safe opaque references.

§sections: Vec<PublicationSection>

Publication-only section headings and optional forced page starts.

§spacers: Vec<PublicationSpacer>

Publication-only vertical gaps inserted before selected systems.

§frames: Vec<PublicationFrame>

Host-rendered page frames with validated physical geometry.

Trait Implementations§

Source§

impl Clone for PublicationConfig

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 PublicationConfig

Source§

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

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

impl Default for PublicationConfig

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for PublicationConfig

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 PartialEq for PublicationConfig

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 PublicationConfig

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 PublicationConfig

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