Struct PlainTextExtractor 

pub struct PlainTextExtractor { /* private fields */ }

Plain text extractor with simplified API

Extracts text from PDF pages without maintaining position information, providing a simpler API by returning String and Vec<String> instead of Vec<TextFragment>.

Architecture

This extractor uses the same content stream parser as TextExtractor, but discards position metadata to provide a simpler output format. It tracks minimal position data (x, y coordinates) to determine spacing and line breaks, then returns clean text strings.

Performance Characteristics

• Memory: O(1) position tracking vs O(n) fragments
• CPU: No fragment sorting, no width calculations
• Performance: Comparable to TextExtractor (same parser)

Thread Safety

PlainTextExtractor is thread-safe and can be reused across multiple pages and documents. Create once, use many times.

Examples

Basic Usage

use oxidize_pdf::parser::PdfReader;
use oxidize_pdf::text::plaintext::PlainTextExtractor;

let doc = PdfReader::open_document("document.pdf")?;

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

println!("{}", result.text);

Custom Configuration

use oxidize_pdf::parser::PdfReader;
use oxidize_pdf::text::plaintext::{PlainTextExtractor, PlainTextConfig};

let doc = PdfReader::open_document("document.pdf")?;

let config = PlainTextConfig {
    space_threshold: 0.3,
    newline_threshold: 12.0,
    preserve_layout: true,
    line_break_mode: oxidize_pdf::text::plaintext::LineBreakMode::Normalize,
    ..Default::default()
};

let mut extractor = PlainTextExtractor::with_config(config);
let result = extractor.extract(&doc, 0)?;

Implementations

impl PlainTextExtractor

pub fn new() -> Self

Create a new extractor with default configuration

Examples

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

let extractor = PlainTextExtractor::new();

pub fn with_config(config: PlainTextConfig) -> Self

Create a new extractor with custom configuration

Examples

use oxidize_pdf::text::plaintext::{PlainTextExtractor, PlainTextConfig};

let config = PlainTextConfig::dense();
let extractor = PlainTextExtractor::with_config(config);

pub fn extract<R: Read + Seek>( &mut self, document: &PdfDocument<R>, page_index: u32, ) -> ParseResult<PlainTextResult>

Extract plain text from a PDF page

Returns text with spaces and newlines inserted according to the configured thresholds. Position information is not included in the result.

Output

Returns a PlainTextResult containing the extracted text as a String, along with character count and line count metadata. This is simpler than TextExtractor which returns Vec<TextFragment> with position data.

Examples

use oxidize_pdf::parser::PdfReader;
use oxidize_pdf::text::plaintext::PlainTextExtractor;

let doc = PdfReader::open_document("document.pdf")?;

let mut extractor = PlainTextExtractor::new();
let result = extractor.extract(&doc, 0)?; // page index 0 = first page

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

pub fn extract_lines<R: Read + Seek>( &mut self, document: &PdfDocument<R>, page_index: u32, ) -> ParseResult<Vec<String>>

Extract text as individual lines

Returns a vector of strings, one for each line detected in the page. Useful for grep-like operations or line-based processing.

Examples

use oxidize_pdf::parser::PdfReader;
use oxidize_pdf::text::plaintext::PlainTextExtractor;

let doc = PdfReader::open_document("document.pdf")?;

let mut extractor = PlainTextExtractor::new();
let lines = extractor.extract_lines(&doc, 0)?;

for (i, line) in lines.iter().enumerate() {
    println!("{}: {}", i + 1, line);
}

pub fn config(&self) -> &PlainTextConfig

Get the current configuration

Examples

use oxidize_pdf::text::plaintext::{PlainTextExtractor, PlainTextConfig};

let config = PlainTextConfig::dense();
let extractor = PlainTextExtractor::with_config(config.clone());
assert_eq!(extractor.config().space_threshold, 0.1);

Trait Implementations

impl Default for PlainTextExtractor

fn default() -> Self

Returns the “default value” for a type.