Skip to main content

CoverPageStyle

Struct CoverPageStyle 

Source
pub struct CoverPageStyle {
Show 30 fields pub enabled: bool, pub margin_x: Option<f32>, pub margin_y: Option<f32>, pub logo: Option<LogoSpec>, pub logo_position: LogoPosition, pub hero: Option<LogoSpec>, pub hero_gap: f32, pub top_margin: f32, pub logo_to_title_gap: f32, pub title_font_size: f32, pub title_accent: String, pub title_accent_color: Option<ColorRgb>, pub title_to_subtitle_gap: f32, pub subtitle: String, pub subtitle_font_size: f32, pub subtitle_to_authors_gap: f32, pub show_authors: bool, pub authors_font_size: f32, pub authors_to_date_gap: f32, pub show_date: bool, pub date_font_size: f32, pub text_color: ColorRgb, pub align: CoverAlign, pub detail_lines: Vec<String>, pub detail_font_size: f32, pub title_to_detail_gap: f32, pub detail_line_gap: f32, pub detail_color: Option<ColorRgb>, pub blank_page_after: bool, pub font_families: Vec<String>,
}

Fields§

§enabled: bool§margin_x: Option<f32>

Horizontal page margin for the cover page only, in points. Defaults to the document margin_x. A smaller value lets cover art (the hero image) bleed wider than the body text column.

§margin_y: Option<f32>

Vertical page margin for the cover page only, in points. Defaults to the document margin_y. A smaller value gives the cover more room (e.g. for a tall hero) and lifts the logo toward the page top. Only honoured when the cover page skips its header / footer.

§logo_position: LogoPosition

Where the logo sits relative to the title. See LogoPosition.

§hero: Option<LogoSpec>

Optional hero image (e.g. a product photo) drawn below the cover metadata — a second image slot so a cover can show both a brand logo (above the title) and a hero image. id / src are templates ({title} / any frontmatter var). Prefer id for an asset-library GUID ({coverImage}); src still accepts a filename such as {title}.png. Unlike the logo, the hero fills the cover column width and keeps the source aspect ratio; width / height on the spec are ignored.

§hero_gap: f32

Gap above the hero image.

§top_margin: f32

Vertical space above the first element on the page (the logo when logo_position = "above", otherwise the title). Defaults to ~1/4 of A4 height.

§logo_to_title_gap: f32

Gap between the logo image and the title text — applied regardless of logo_position. When above, the gap is below the logo; when below_title, it’s between the title and the logo.

§title_font_size: f32§title_accent: String

Optional accent run appended inline to the title and rendered in a lighter weight and (optionally) a different colour — e.g. a title of “MyProduct” with title_accent = " Manual" renders the product name bold and “Manual” in a muted accent beside it. The string is a template ({title} / {date} / any frontmatter var) so the accent can come from metadata; empty omits it.

§title_accent_color: Option<ColorRgb>

Colour for title_accent. Defaults to text_color when unset.

§title_to_subtitle_gap: f32§subtitle: String

Template string for the subtitle — supports the same {title}/{description}/{date} substitutions as headers. Empty string omits the subtitle entirely.

§subtitle_font_size: f32§subtitle_to_authors_gap: f32§show_authors: bool§authors_font_size: f32§authors_to_date_gap: f32§show_date: bool§date_font_size: f32§text_color: ColorRgb§align: CoverAlign

Horizontal alignment of every cover text block (title, subtitle, detail lines, authors, date). Defaults to centred.

§detail_lines: Vec<String>

Extra metadata lines rendered under the title, each a template string ({title} / {description} / {date} / any RenderContext var). Use for “Date: {date}”, “Version: {version}”, etc. A line whose substitution is empty is skipped.

§detail_font_size: f32

Font size for detail_lines.

§title_to_detail_gap: f32

Gap below the title before the detail lines.

§detail_line_gap: f32

Vertical gap between consecutive detail lines.

§detail_color: Option<ColorRgb>

Colour for detail_lines. Defaults to text_color when unset; typically a muted grey.

§blank_page_after: bool

When true, insert a fully blank page directly after the cover page so the body content starts on page 3 — a recto in double-sided printing. Useful for printed reports / books; no effect when the document is read on screen.

§font_families: Vec<String>

Font families for this element, in fallback order. Empty means “inherit the document body families” (body_font_families, or the bundled Noto defaults when that is also empty). Names must be families the font collection knows — either system-installed or exposed by a file listed in font_paths.

Note this REPLACES the body list rather than extending it, so a Latin-only face here will lose the multi-script fallbacks. List the scripts you need explicitly if the document is not Latin-only.

Trait Implementations§

Source§

impl Clone for CoverPageStyle

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 CoverPageStyle

Source§

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

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

impl Default for CoverPageStyle

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for CoverPageStyle

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

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> ErasedDestructor for T
where T: 'static,

Source§

impl<T> Finish for T

Source§

fn finish(self)

Does nothing but move self, equivalent to drop.
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<U, T> ToOwnedObj<U> for T
where U: FromObjRef<T>,

Source§

fn to_owned_obj(&self, data: FontData<'_>) -> U

Convert this type into T, using the provided data to resolve any offsets.
Source§

impl<U, T> ToOwnedTable<U> for T
where U: FromTableRef<T>,

Source§

fn to_owned_table(&self) -> U

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.