Class: LiteParse::ParseResult

Inherits:

Object

• Object
• LiteParse::ParseResult

Defined in:

lib/liteparse/types.rb

Overview

The complete result of parsing a document.

Instance Method Summary

• #get_page(page_num) ⇒ LiteParse::ParsedPage^?

  Retrieve a specific page by its 1-indexed page number.

• #images ⇒ Array<LiteParse::ExtractedImage>

  Images extracted from the document.

• #num_pages ⇒ Integer

  Total number of pages parsed.

• #pages ⇒ Array<LiteParse::ParsedPage>

  All parsed pages.

• #text ⇒ String

  Full concatenated text across all pages.

Instance Method Details

#get_page(page_num) ⇒ LiteParse::ParsedPage^?

Retrieve a specific page by its 1-indexed page number.

Parameters:

• page_num (Integer) —

  1-indexed page number

Returns:

• (LiteParse::ParsedPage, nil) —

  The page, or nil if not found

# File 'lib/liteparse/types.rb', line 52

class ParseResult; end

#images ⇒ Array<LiteParse::ExtractedImage>

Returns Images extracted from the document.

Returns:

• (Array<LiteParse::ExtractedImage>) —

  Images extracted from the document

# File 'lib/liteparse/types.rb', line 52

class ParseResult; end

#num_pages ⇒ Integer

Returns Total number of pages parsed.

Returns:

• (Integer) —

  Total number of pages parsed

# File 'lib/liteparse/types.rb', line 52

class ParseResult; end

#pages ⇒ Array<LiteParse::ParsedPage>

Returns All parsed pages.

Returns:

• (Array<LiteParse::ParsedPage>) —

  All parsed pages

# File 'lib/liteparse/types.rb', line 52

class ParseResult; end

#text ⇒ String

Returns Full concatenated text across all pages.

Returns:

• (String) —

  Full concatenated text across all pages

# File 'lib/liteparse/types.rb', line 52

class ParseResult; end