Struct PlainTextResult 

pub struct PlainTextResult {
    pub text: String,
    pub line_count: usize,
    pub char_count: usize,
}

Result of plain text extraction

Contains the extracted text and metadata about the extraction. Unlike ExtractedText, this does not include position information for individual text fragments.

Examples

use oxidize_pdf::Document;
use oxidize_pdf::text::plaintext::PlainTextExtractor;

let doc = Document::open("document.pdf")?;
let page = doc.get_page(1)?;

let extractor = PlainTextExtractor::new();
let result = extractor.extract(&doc, page)?;

println!("Extracted {} characters in {} lines",
    result.char_count,
    result.line_count
);

Fields

text: String

Extracted text content

The complete text content from the page, with spaces and newlines inserted according to the configured thresholds and line break mode.

line_count: usize

Number of lines in the extracted text

Lines are counted by splitting on \n characters. A document with no newlines will have a line_count of 1.

char_count: usize

Number of characters in the extracted text

Total character count including spaces and newlines.

Implementations

impl PlainTextResult

pub fn new(text: String) -> Self

Create a new result from text

Automatically calculates line_count and char_count from the text.

Examples

use oxidize_pdf::text::plaintext::PlainTextResult;

let result = PlainTextResult::new("Hello\nWorld".to_string());
assert_eq!(result.line_count, 2);
assert_eq!(result.char_count, 11);

pub fn empty() -> Self

Create an empty result

Examples

use oxidize_pdf::text::plaintext::PlainTextResult;

let result = PlainTextResult::empty();
assert_eq!(result.text, "");
assert_eq!(result.line_count, 0);
assert_eq!(result.char_count, 0);

pub fn is_empty(&self) -> bool

Check if the result is empty

Examples

use oxidize_pdf::text::plaintext::PlainTextResult;

let result = PlainTextResult::empty();
assert!(result.is_empty());

let result = PlainTextResult::new("text".to_string());
assert!(!result.is_empty());

Trait Implementations

impl Clone for PlainTextResult

fn clone(&self) -> PlainTextResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlainTextResult

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

Formats the value using the given formatter.

impl Eq for PlainTextResult

impl PartialEq for PlainTextResult

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PlainTextResult