Struct PositionOptions 

#[non_exhaustive]
pub struct PositionOptions {
    pub frame: PositionFrame,
    pub bold_from_weight: bool,
    pub bold_weight_threshold: u16,
}

Options of the positioned-text and region APIs, taken by their _with_options variants (extract_text_with_positions_mem_with_options, extract_text_with_positions_and_rotations_mem_with_options, extract_text_in_regions_mem_with_options, extract_tables_in_regions_mem_with_options). The default is what the plain and _in_frame variants do.

use pdf_inspector::{PositionFrame, PositionOptions};

let options = PositionOptions::new()
    .frame(PositionFrame::Display)
    .bold_from_weight(true)
    .bold_weight_threshold(700);

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

frame: PositionFrame

Coordinate frame items are reported in and region rects are read in; PositionFrame::Sheet by default.

bold_from_weight: bool

Read bold from the font’s weight class as well. When set, TextItem::is_bold is also true for items whose TextItem::font_weight is bold_weight_threshold (600, SemiBold, by default) or more, TextItem::bold_source says so, and adjacent runs are merged by that verdict: a run the weight makes bold stays apart from its plain neighbours, so a heavier run inside a lighter paragraph keeps its own item, while runs whose weights differ but agree on bold — both below the threshold, or both at or above it — merge as usual. Off by default: is_bold and item merging are then exactly what they were before the option existed, and font_weight is reported either way.

bold_weight_threshold: u16

The weight class from which bold_from_weight reads bold, on the 100..=900 scale: 600 by default, so SemiBold and heavier faces are bold. It matters only when bold_from_weight is set; a value outside the scale is clamped into it either way.

Implementations

impl PositionOptions

pub fn new() -> Self

The defaults: sheet frame, bold not read from the weight class, a threshold of 600 for when it is.

pub fn frame(self, frame: PositionFrame) -> Self

Set the coordinate frame.

pub fn bold_from_weight(self, bold_from_weight: bool) -> Self

Set whether bold is also read from the weight class.

pub fn bold_weight_threshold(self, threshold: u16) -> Self

Set the weight class from which bold is read when bold_from_weight is on: 600 by default, valid values 100..=900.

Trait Implementations

impl Clone for PositionOptions

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for PositionOptions

impl Debug for PositionOptions

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

Formats the value using the given formatter.

impl Default for PositionOptions

fn default() -> Self

Returns the “default value” for a type.

impl Eq for PositionOptions

impl PartialEq for PositionOptions

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for PositionOptions