Skip to main content

HeaderFooterStyle

Struct HeaderFooterStyle 

Source
pub struct HeaderFooterStyle {
Show 17 fields pub left: String, pub center: String, pub right: String, pub font_size: f32, pub color: ColorRgb, pub margin_from_edge: f32, pub rule: bool, pub rule_color: ColorRgb, pub rule_thickness: f32, pub rule_gap: f32, pub max_lines: u8, pub logo_left: Option<LogoSpec>, pub logo_center: Option<LogoSpec>, pub logo_right: Option<LogoSpec>, pub even: Option<HeaderFooterSlots>, pub per_chapter: HashMap<String, HeaderFooterSlots>, pub font_families: Vec<String>,
}

Fields§

§left: String§center: String§right: String§font_size: f32§color: ColorRgb§margin_from_edge: f32

Distance from the page edge (top edge for header, bottom edge for footer).

§rule: bool

If true, draws a thin separator rule between the decoration and the body (under a header, above a footer).

§rule_color: ColorRgb§rule_thickness: f32§rule_gap: f32

Vertical gap between the text and the rule (when rule = true).

§max_lines: u8

Maximum number of text lines a slot is allowed to wrap into. Pagination reserves vertical space for this many lines so the body never collides with a multi-line band. Defaults to 1.

§logo_left: Option<LogoSpec>

Optional logo image for each slot. When set, the logo replaces any text template for that slot. Sized exactly as configured — no automatic scaling; pick width and height to match your reserved band height.

§logo_center: Option<LogoSpec>§logo_right: Option<LogoSpec>§even: Option<HeaderFooterSlots>

Optional even-page (verso) slot overrides. Page 1 is treated as recto (odd). When set and the current page is even, the corresponding slot template is used in place of the odd counterpart — typical book layout has e.g. chapter title on recto, document title on verso. Empty strings mean “fall back to the odd slot”.

§per_chapter: HashMap<String, HeaderFooterSlots>

Per-h1-chapter slot overrides. Keyed by exact h1 text; the renderer switches as soon as a heading at that level is seen on the page, so the same page never mixes two chapters’ headers. Empty string slots fall back to the parent.

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

Implementations§

Source§

impl HeaderFooterStyle

Source

pub fn resolved_slots( &self, page_number: usize, chapter: &str, ) -> (String, String, String)

Resolve the (left, center, right) slot strings effective for this page given its parity and current chapter. Per-chapter overrides take precedence; even-page overrides apply next; missing/empty fields fall back to the parent slot.

Source§

impl HeaderFooterStyle

Source

pub fn reserved_height(&self) -> f32

Total vertical space this decoration consumes from one edge of the page (text height × max_lines + rule gap + rule thickness).

Trait Implementations§

Source§

impl Clone for HeaderFooterStyle

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 HeaderFooterStyle

Source§

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

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

impl Default for HeaderFooterStyle

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for HeaderFooterStyle

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.