Struct Match 

#[non_exhaustive]
pub struct Match {
    pub path: PathBuf,
    pub page: u32,
    pub text: String,
    pub byte_span: (usize, usize),
}

A single matched occurrence in a PDF page (FR-040).

byte_span indexes into Match.text — slicing &text[byte_span.0..byte_span.1] yields the matched substring. UTF-8 codepoint boundaries are aligned.

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.

path: PathBuf

Source path of the PDF containing this match.

page: u32

1-indexed page number where the match was found.

text: String

Full containing line of extracted text (the substring of page text between adjacent line breaks). When -o/only_matching is set on the runner, text is the matched span only.

byte_span: (usize, usize)

(start, end) byte offsets within Match.text for the matched substring.

Trait Implementations

impl Clone for Match

fn clone(&self) -> Match

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Match

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

Formats the value using the given formatter.

impl PartialEq for Match

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

impl StructuralPartialEq for Match