Struct PlainTextConfig 

pub struct PlainTextConfig {
    pub space_threshold: f64,
    pub newline_threshold: f64,
    pub preserve_layout: bool,
    pub line_break_mode: LineBreakMode,
}

Configuration for plain text extraction

Controls how text is extracted and formatted when position information is not required. Thresholds are expressed in text space units and should be tuned based on your specific PDF characteristics.

Default Configuration

use oxidize_pdf::text::plaintext::PlainTextConfig;

let config = PlainTextConfig::default();
assert_eq!(config.space_threshold, 0.3);
assert_eq!(config.newline_threshold, 10.0);
assert!(!config.preserve_layout);

Fields

space_threshold: f64

Space detection threshold (multiple of average character width)

When horizontal displacement between characters exceeds this threshold (expressed as a multiple of the average character width), a space character is inserted.

• Lower values (0.1-0.2): More spaces inserted, good for tightly-spaced text
• Default (0.3): Balanced for most documents
• Higher values (0.4-0.5): Fewer spaces, good for wide-spaced text

Range: 0.05 to 1.0 (typical)

newline_threshold: f64

Newline detection threshold (multiple of line height)

When vertical displacement between text elements exceeds this threshold (in text space units), a newline character is inserted.

• Lower values (5.0-8.0): More line breaks, preserves paragraph structure
• Default (10.0): Balanced for most documents
• Higher values (15.0-20.0): Fewer line breaks, joins more text

Range: 1.0 to 50.0 (typical)

preserve_layout: bool

Preserve original layout whitespace

When true, attempts to maintain the original document’s whitespace structure (indentation, spacing) by inserting appropriate spaces and newlines based on position changes in the PDF.

When false, uses minimal whitespace (single spaces between words, single newlines between paragraphs).

Use true for:

• Documents with tabular data
• Code listings or formatted text
• Documents where indentation matters

Use false for:

• Plain text extraction for search indexing
• Content analysis where layout doesn’t matter
• Maximum performance (less processing)

line_break_mode: LineBreakMode

Line break handling mode

Controls how line breaks in the PDF are interpreted and processed. Different modes are useful for different document types and use cases.

Implementations

impl PlainTextConfig

pub fn new() -> Self

Create a new configuration with default values

Examples

use oxidize_pdf::text::plaintext::PlainTextConfig;

let config = PlainTextConfig::new();

pub fn dense() -> Self

Create a configuration optimized for dense text (tight spacing)

Lower thresholds detect spaces more aggressively, useful for PDFs with minimal character spacing.

Examples

use oxidize_pdf::text::plaintext::PlainTextConfig;

let config = PlainTextConfig::dense();
assert_eq!(config.space_threshold, 0.1);

pub fn loose() -> Self

Create a configuration optimized for loose text (wide spacing)

Higher thresholds avoid false space detection in documents with generous character spacing.

Examples

use oxidize_pdf::text::plaintext::PlainTextConfig;

let config = PlainTextConfig::loose();
assert_eq!(config.space_threshold, 0.4);

pub fn preserve_layout() -> Self

Create a configuration that preserves layout structure

Useful for documents with tabular data, code, or formatted text where whitespace is semantically important.

Examples

use oxidize_pdf::text::plaintext::PlainTextConfig;

let config = PlainTextConfig::preserve_layout();
assert!(config.preserve_layout);

Trait Implementations

impl Clone for PlainTextConfig

fn clone(&self) -> PlainTextConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlainTextConfig

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

Formats the value using the given formatter.

impl Default for PlainTextConfig

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for PlainTextConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for PlainTextConfig