Struct PageState 

pub struct PageState {

    pub contrib_head: NodeRef,
    pub page_head: NodeRef,
    pub page_tail: NodeRef,
    pub so_far: [i32; 8],
    pub fi_stretch: i32,
    pub max_depth: i32,
    pub contents: PageContents,
    pub best_break: NodeRef,
    pub least_cost: i32,
    pub best_size: i32,
    pub best_so_far: [i32; 8],
    pub best_infinite: bool,
    pub last_break: Option<PageBreakInfo>,
    pub ins: Vec<PageIns>,
    pub last_glue: Option<Glue>,
    pub last_penalty: i32,
    pub last_kern: i32,
    pub last_node_type: i32,
}

The state of the page builder (§980–§982).

Fields

contrib_head: NodeRef

Head of the contribution list.

page_head: NodeRef

Head of the current page.

page_tail: NodeRef

Tail of the current page.

so_far: [i32; 8]

page_so_far: goal, total, stretch (normal, fil, fill, filll), shrink, depth. The fi stretch is in PageState::fi_stretch.

fi_stretch: i32

Page stretch of order fi (LuaTeX).

max_depth: i32

page_max_depth.

contents: PageContents

What the page contains.

best_break: NodeRef

The best break found so far (best_page_break).

least_cost: i32

Its cost (least_page_cost).

best_size: i32

The page goal at the best break (best_size).

best_so_far: [i32; 8]

so_far at the best break (for crate::pagenote).

best_infinite: bool

Whether the page had infinite stretch at the best break.

last_break: Option<PageBreakInfo>

What the last page break left out (default output mode).

ins: Vec<PageIns>

Insertion classes on the page, in increasing class order.

last_glue: Option<Glue>

\lastskip etc. of the page (last_glue); None if the last item was not glue.

last_penalty: i32

last_penalty.

last_kern: i32

last_kern.

last_node_type: i32

\lastnodetype of the page.

Implementations

impl PageState

pub fn init(&mut self, nodes: &mut Nodes)

Allocates the list heads.

pub fn stretch(&self, o: u8) -> i32

The page stretch of glue order o (LuaTeX numbering).

pub fn stretch_mut(&mut self, o: u8) -> &mut i32

Mutable access to the page stretch of order o.

Trait Implementations

impl Clone for PageState

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PageState

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

Formats the value using the given formatter.

impl Default for PageState

fn default() -> Self

Returns the “default value” for a type.