Struct Scan 

pub struct Scan {
    pub db: ObjectDB,
    /* private fields */
}

Scan post-processor: collects structural information into ObjectDB.

Port of LaTeXML::Post::Scan.

Fields

db: ObjectDB

Reference to the shared ObjectDB.

Implementations

impl Scan

pub fn new(db: ObjectDB) -> Self

pub fn scan(&mut self, doc: &PostDocument, node: &Node, parent_id: Option<&str>)

Recursively scan a node and its children.

Port of Scan::scan.

pub fn scan_children( &mut self, doc: &PostDocument, node: &Node, parent_id: Option<&str>, )

Scan all element children of a node.

Trait Implementations

impl Processor for Scan

fn get_name(&self) -> &str

Human-readable name for this processor.

fn process(&mut self, doc: PostDocument, _nodes: Vec<Node>) -> ProcessResult

Process the document given the nodes returned by to_process. Returns the resulting document(s) — splitting may produce multiple.

fn resource_directory(&self) -> Option<&str>

Resource directory for generated resources (images, etc.).

fn resource_prefix(&self) -> Option<&str>

Resource prefix for generated resource filenames.

fn to_process(&self, doc: &PostDocument) -> Vec<Node>

Return the nodes to be processed; by default the document element. This allows processors to focus on specific kinds of nodes, or to skip processing if there are none to process.

fn desired_resource_pathname( &self, _doc: &PostDocument, _node: &Node, _source: Option<&str>, _type_ext: Option<&str>, ) -> Option<PathBuf>

Hint for a desired resource pathname.

fn generate_resource_pathname( &self, doc: &mut PostDocument, _node: &Node, _source: Option<&str>, type_ext: Option<&str>, ) -> PathBuf

Auto-generate a unique resource pathname using a counter from the doc cache.