Struct HOCR

pub struct HOCR {
    pub system: String,
    pub capabilities: Vec<String>,
    pub number_of_pages: Option<u32>,
    pub langs: Option<Vec<String>>,
    pub scripts: Option<Vec<String>>,
    pub elements: Vec<Element>,
}

Represents a hOCR file.

Fields

system: String

capabilities: Vec<String>

number_of_pages: Option<u32>

langs: Option<Vec<String>>

scripts: Option<Vec<String>>

elements: Vec<Element>

Implementations

impl HOCR

pub fn iter(&self) -> ElementsIterator<'_>

Returns an iterator over all elements in the hOCR document. Note that the iterator returns elements in a breadth-first order.

Examples found in repository

examples/parse.rs (line 12)

fn main() -> hocr_parser::Result<()> {
    let xml_str = std::fs::read_to_string("examples/data/paper-image.hocr").unwrap();
    let hocr = HOCR::from_str(&xml_str)?;

    println!("OCR System: {}", &hocr.system);
    println!("Capabilities: {:?}", &hocr.capabilities);
    println!("Number of Pages: {:?}", &hocr.number_of_pages);
    println!("Langs: {:?}", &hocr.langs);
    println!("Scripts: {:?}", &hocr.scripts);
    println!("# of Elements: {}", hocr.iter().count());

    Ok(())
}

impl HOCR

pub fn from_str(xml_str: &str) -> Result<Self>

Create a new HOCR instance from a string containing hOCR XML.

Examples found in repository

examples/parse.rs (line 5)

fn main() -> hocr_parser::Result<()> {
    let xml_str = std::fs::read_to_string("examples/data/paper-image.hocr").unwrap();
    let hocr = HOCR::from_str(&xml_str)?;

    println!("OCR System: {}", &hocr.system);
    println!("Capabilities: {:?}", &hocr.capabilities);
    println!("Number of Pages: {:?}", &hocr.number_of_pages);
    println!("Langs: {:?}", &hocr.langs);
    println!("Scripts: {:?}", &hocr.scripts);
    println!("# of Elements: {}", hocr.iter().count());

    Ok(())
}

pub fn from_hocr_borrowed(hocr: HOCRBorrowed<'_>) -> Self

Create a new HOCR instance from a HOCRBorrowed.

Trait Implementations

impl Clone for HOCR

fn clone(&self) -> HOCR

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HOCR

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

Formats the value using the given formatter.