Skip to main content

WordGap

Enum WordGap 

Source
pub enum WordGap {
    Legacy,
    Factor(f64),
    Adaptive,
}
Expand description

How a word boundary is decided where the PDF draws no space glyph — a word set apart only by moving the text cursor (#921).

WordGap::Adaptive, the default, and WordGap::Factor follow docling-parse ≥ 7’s contractor (cells.h::contract, 2026-09, PR #351 — what docling ≥ 2.142 runs on, docling-parse>=7.22): glyphs are grouped into line runs by geometry alone (no font boundary), every gap between two visible glyphs is normalized by the mean advance of those two glyphs, and a normalized gap above the threshold starts a new word; an explicit space glyph is always a boundary. Line cells are the run’s words joined by single spaces. Letter spacing is detected first ([tracked_gaps]) — our addition, where docling-parse cuts letter-spaced words mid-word.

WordGap::Legacy is the contraction above: the docling-parse ≤ 6 rule this port started from, where a gap splits two words when it exceeds 0.33 × the running mean advance of the cell accumulated so far — a cell that restarts at every font change, so the threshold drifts along a line (und dem in a second font resource read unddem: 1.955 pt against 0.33 × 5.925 pt, the mean of und alone).

Variants§

§

Legacy

docling-parse ≤ 6’s running-mean contraction.

§

Factor(f64)

A fixed normalized threshold for every line.

§

Adaptive

docling-parse ≥ 7’s line-local threshold: a two-cluster k-means over the line’s normalized gaps (character spacing vs word spacing), at least 0.18, capped at 0.35, 0.25 when the gaps do not separate.

Implementations§

Source§

impl WordGap

Source

pub const ACCEPTED: &'static str = "legacy, adaptive, or a factor in (0, 4]"

The accepted spellings, for error messages.

Source

pub fn parse(s: &str) -> Result<Self, String>

legacy / adaptive / a positive factor up to 4 (case-insensitive); Err with the reason for anything else.

Source

pub fn from_env() -> Self

DOCLING_RS_PDF_WORD_GAP, or the default (WordGap::Adaptive) when it is unset (an unreadable value warns once and keeps the default).

Trait Implementations§

Source§

impl Clone for WordGap

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for WordGap

Source§

impl Debug for WordGap

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for WordGap

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for WordGap

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for WordGap

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, S> SimdFrom<T, S> for T
where S: Simd,

Source§

fn simd_from(_simd: S, value: T) -> T

Source§

impl<F, T, S> SimdInto<T, S> for F
where T: SimdFrom<F, S>, S: Simd,

Source§

fn simd_into(self, simd: S) -> T

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V