Enum LineBreakMode 

pub enum LineBreakMode {
    Auto,
    PreserveAll,
    Normalize,
}

Line break handling mode

Controls how line breaks in the PDF are interpreted. PDFs often include line breaks for layout purposes that should be removed when extracting continuous text (e.g., hyphenated words at line ends).

Examples

use oxidize_pdf::text::plaintext::LineBreakMode;

let mode = LineBreakMode::Auto;         // Detect based on context
let mode = LineBreakMode::PreserveAll;  // Keep all line breaks
let mode = LineBreakMode::Normalize;    // Join hyphenated words

Variants

Auto

Automatically detect line breaks

Uses heuristics to determine if a line break is semantic (paragraph end) or just for layout (line wrap). Joins lines that appear to be wrapped.

Best for: General-purpose text extraction

PreserveAll

Preserve all line breaks from PDF

Every line break in the PDF becomes a newline in the output. Useful when the PDF’s line breaks are semantically meaningful.

Best for: Poetry, code listings, formatted text

Normalize

Normalize line breaks (join hyphenated words)

Detects hyphenated words at line ends (e.g., “docu-\nment”) and joins them into single words (“document”). Other line breaks are preserved.

Best for: Continuous text extraction from books, articles

Trait Implementations

impl Clone for LineBreakMode

fn clone(&self) -> LineBreakMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineBreakMode

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

Formats the value using the given formatter.

impl Hash for LineBreakMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for LineBreakMode

fn eq(&self, other: &LineBreakMode) -> 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 Copy for LineBreakMode

impl Eq for LineBreakMode

impl StructuralPartialEq for LineBreakMode