Skip to main content

SectionDef

Struct SectionDef 

Source
pub struct SectionDef {
    pub id: String,
    pub name: String,
    pub folio_start: Option<usize>,
    pub folio_style: Option<String>,
    pub start_page: String,
    pub source_span: Option<Span>,
}
Expand description

A section — a named, contiguous range of pages with its own folio numbering, used for front-matter / chapters / appendices. A section LABELS pages (like PDF page labels); it does not contain them. The range runs from start_page until the next section’s start_page (or the document end).

Declared in the document-level sections block as a leaf entry: section id="sec.front" name="Front Matter" start-page="page.cover". The section id itself participates in the global id-uniqueness set.

Fields§

§id: String

Globally-unique section id.

§name: String

Human-readable section name (e.g. “Front Matter”, “Chapter 1”). Usable as section-aware running-head text in a later unit.

§folio_start: Option<usize>

First folio number for this section (1-based). None defaults to 1.

§folio_style: Option<String>

Folio numbering style for this section: "decimal" (default), "lower-roman", "upper-roman". None defaults to decimal.

§start_page: String

Id of the page that begins this section.

§source_span: Option<Span>

Source declaration span, when available.

Trait Implementations§

Source§

impl Clone for SectionDef

Source§

fn clone(&self) -> SectionDef

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 SectionDef

Source§

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

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

impl PartialEq for SectionDef

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl StructuralPartialEq for SectionDef

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 = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.