Struct Fragment 

pub struct Fragment {
    pub root: NodeId,
    pub nodes: Vec<LayoutNode>,
    pub source_map: SourceMap,
    pub metadata: FragmentMetadata,
    pub surface: Surface,
}

One typeset fragment: a tree of layout nodes rooted at root, stored densely by id.

Fields

root: NodeId

The root node, placed at (0, 0) with its reference point on the surface baseline.

nodes: Vec<LayoutNode>

Every node of the tree, nodes[i].id == NodeId(i).

source_map: SourceMap

Source files and enclosing construct spans.

metadata: FragmentMetadata

How the fragment was produced.

surface: Surface

Extent of the root box, surface.baseline == root.height.

Implementations

impl Fragment

pub fn new( root: NodeId, nodes: Vec<LayoutNode>, source_map: SourceMap, metadata: FragmentMetadata, ) -> Result<Self, FragmentError>

Builds a fragment, deriving the surface from the root and checking every invariant.

pub fn validate(&self) -> Result<(), FragmentError>

Checks dense ids, a single tree under the root, the root placement, the surface and source ids.

pub fn node(&self, id: NodeId) -> Option<&LayoutNode>

Returns the node with the given id in constant time.

pub fn root_node(&self) -> Option<&LayoutNode>

Returns the root node, None for an empty fragment.

pub fn children(&self, id: NodeId) -> &[NodeId]

Returns the children of a node, empty for leaves and unknown ids.

pub fn source_entries_for_node( &self, node: NodeId, ) -> impl Iterator<Item = &SourceMapEntry>

Iterates the enclosing construct entries of a node, innermost first.

pub fn source_origins_for_node( &self, node: NodeId, ) -> impl Iterator<Item = SourceOrigin<'_>>

Iterates the node’s primary origin followed by its enclosing construct origins.

pub fn primary_source_for_node(&self, node: NodeId) -> Option<SourceRange>

Returns the primary source range of a node.

pub fn glyph_source_range( &self, node: NodeId, glyph_index: usize, ) -> Option<SourceRange>

Resolves a glyph’s cluster span to a range in the node’s primary source file.

pub fn glyph_source_origin( &self, node: NodeId, glyph_index: usize, ) -> Option<SourceOrigin<'_>>

Resolves a glyph’s cluster span to a full source origin.

pub fn flatten(&self) -> Vec<Placed<'_>>

Absolute glyphs and rules in tree order, y down, origin at the surface top left.

Trait Implementations

impl Clone for Fragment

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 Fragment

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

Formats the value using the given formatter.

impl Default for Fragment

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for Fragment

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Fragment