Struct PdfiumSearchFlags 

pub struct PdfiumSearchFlags(/* private fields */);

A bitflag type representing various search options for PDF text searching.

This struct wraps PDFium library constants to provide a type-safe way to combine multiple search flags using bitwise operations.

Examples

use pdfium::*;

// Search with no flags
let flags = PdfiumSearchFlags::empty();

// Search with case sensitivity
let flags = PdfiumSearchFlags::MATCH_CASE;

// Search for whole words only, case-sensitive
let flags = PdfiumSearchFlags::MATCH_CASE | PdfiumSearchFlags::MATCH_WHOLE_WORD;

// Use all search options
let flags = PdfiumSearchFlags::all();

Implementations

impl PdfiumSearchFlags

pub const MATCH_CASE: Self

Enables case-sensitive text matching during PDF search operations. When this flag is set, “Hello” will not match “hello”.

pub const MATCH_WHOLE_WORD: Self

Enables whole word matching during PDF search operations. When this flag is set, searching for “cat” will not match “category”. The search term must be bounded by word boundaries (spaces, punctuation, etc.).

pub const CONSECUTIVE: Self

The CONSECUTIVE flag modifies the behavior of the text search to start the next or previous search from the position immediately following or preceding the current match, rather than skipping to the end or start of the current match. This is particularly useful for finding overlapping or consecutive matches of the search term in the text.

• Behavior with CONSECUTIVE:

  • When this flag is set, the search continues from the character immediately after the start of the current match (for FPDFText_FindNext) or immediately before the end of the current match (for FPDFText_FindPrev).
  • This allows the search to potentially find overlapping instances of the search term. For example, searching for “ana” in “banana” could find matches at positions 1 (“ana”) and 3 (“ana”) if CONSECUTIVE is enabled.
  • Without this flag, the search would typically skip to the position after the end of the current match (for FPDFText_FindNext) or before the start of the current match (for FPDFText_FindPrev), potentially missing overlapping matches.

• Default Behavior (without CONSECUTIVE):

  • If the flag is not set, after finding a match, FPDFText_FindNext starts the next search from the character after the end of the current match (m_resEnd + 1), and FPDFText_FindPrev starts from the character before the start of the current match (m_resStart - 1). This prevents overlapping matches.

impl PdfiumSearchFlags

pub const fn empty() -> Self

Get a flags value with all bits unset.

Examples found in repository

examples/text_extract_search.rs (line 93)

pub fn example_search() -> PdfiumResult<()> {
    // Load the PDF document to search within
    let document = PdfiumDocument::new_from_path("resources/groningen.pdf", None)?;

    // Get the first page (index 0) for searching
    let page = document.page(0)?;

    // Extract text objects from the page for searching
    let text = page.text()?;

    // Search for "amsterdam" with case-insensitive matching
    // PdfiumSearchFlags::empty() means no special search flags (case-insensitive by default)
    // The last parameter (0) is the starting position for the search
    let search = text.find("amsterdam", PdfiumSearchFlags::empty(), 0);
    println!("Found amsterdam {} times", search.count());

    // Search for "groningen" with case-insensitive matching
    let search = text.find("groningen", PdfiumSearchFlags::empty(), 0);
    println!(
        "Found groningen {} times (case insensitive)",
        search.count()
    );

    // Search for "Groningen" with case-sensitive matching
    // MATCH_CASE flag enforces exact case matching
    let search = text.find("Groningen", PdfiumSearchFlags::MATCH_CASE, 0);
    println!("Found Groningen {} times (case sensitive)", search.count());

    // Perform another case-insensitive search to iterate through results
    let search = text.find("groningen", PdfiumSearchFlags::empty(), 0);

    // Iterate through each search result to extract detailed information
    for result in search {
        // Extract the text fragment at the found position
        // result.index() gives the character position where the match starts
        // result.count() gives the length of the matched text
        let fragment = text.extract(result.index(), result.count());
        println!(
            "Found groningen (case insensitive) at {}, fragment = '{fragment}'",
            result.index()
        );
    }

    // Expected output:
    //
    // Found amsterdam 0 times
    // Found groningen 5 times (case insensitive)
    // Found Groningen 5 times (case sensitive)
    // Found groningen (case insensitive) at 14, fragment = 'Groningen'
    // Found groningen (case insensitive) at 232, fragment = 'Groningen'
    // Found groningen (case insensitive) at 475, fragment = 'Groningen'
    // Found groningen (case insensitive) at 920, fragment = 'Groningen'
    // Found groningen (case insensitive) at 1050, fragment = 'Groningen'

    Ok(())
}

pub const fn all() -> Self

Get a flags value with all known bits set.

pub const fn bits(&self) -> i32

Get the underlying bits value.

The returned value is exactly the bits set in this flags value.

pub const fn from_bits(bits: i32) -> Option<Self>

Convert from a bits value.

This method will return None if any unknown bits are set.

pub const fn from_bits_truncate(bits: i32) -> Self

Convert from a bits value, unsetting any unknown bits.

pub const fn from_bits_retain(bits: i32) -> Self

Convert from a bits value exactly.

pub fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

This method will return None if name is empty or doesn’t correspond to any named flag.

pub const fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

pub const fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

pub const fn intersects(&self, other: Self) -> bool

Whether any set bits in a source flags value are also set in a target flags value.

pub const fn contains(&self, other: Self) -> bool

Whether all set bits in a source flags value are also set in a target flags value.

pub fn insert(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

pub fn remove(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. remove won’t truncate other, but the ! operator will.

pub fn toggle(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

pub fn set(&mut self, other: Self, value: bool)

Call insert when value is true or remove when value is false.

pub const fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

pub const fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

pub const fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

pub const fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

pub const fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl PdfiumSearchFlags

pub const fn iter(&self) -> Iter<PdfiumSearchFlags>

Yield a set of contained flags values.

Each yielded flags value will correspond to a defined named flag. Any unknown bits will be yielded together as a final flags value.

pub const fn iter_names(&self) -> IterNames<PdfiumSearchFlags>

Yield a set of contained named flags values.

This method is like iter, except only yields bits in contained named flags. Any unknown bits, or bits not corresponding to a contained flag will not be yielded.

Trait Implementations

impl Binary for PdfiumSearchFlags

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

Formats the value using the given formatter.

impl BitAnd for PdfiumSearchFlags

fn bitand(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

type Output = PdfiumSearchFlags

The resulting type after applying the & operator.

impl BitAndAssign for PdfiumSearchFlags

fn bitand_assign(&mut self, other: Self)

The bitwise and (&) of the bits in two flags values.

impl BitOr for PdfiumSearchFlags

fn bitor(self, other: PdfiumSearchFlags) -> Self

The bitwise or (|) of the bits in two flags values.

type Output = PdfiumSearchFlags

The resulting type after applying the | operator.

impl BitOrAssign for PdfiumSearchFlags

fn bitor_assign(&mut self, other: Self)

The bitwise or (|) of the bits in two flags values.

impl BitXor for PdfiumSearchFlags

fn bitxor(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

type Output = PdfiumSearchFlags

The resulting type after applying the ^ operator.

impl BitXorAssign for PdfiumSearchFlags

fn bitxor_assign(&mut self, other: Self)

The bitwise exclusive-or (^) of the bits in two flags values.

impl Clone for PdfiumSearchFlags

fn clone(&self) -> PdfiumSearchFlags

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PdfiumSearchFlags

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

Formats the value using the given formatter.

impl Extend<PdfiumSearchFlags> for PdfiumSearchFlags

fn extend<T: IntoIterator<Item = Self>>(&mut self, iterator: T)

The bitwise or (|) of the bits in each flags value.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Flags for PdfiumSearchFlags

const FLAGS: &'static [Flag<PdfiumSearchFlags>]

The set of defined flags.

type Bits = i32

The underlying bits type.

fn bits(&self) -> i32

Get the underlying bits value.

fn from_bits_retain(bits: i32) -> PdfiumSearchFlags

Convert from a bits value exactly.

fn empty() -> Self

Get a flags value with all bits unset.

fn all() -> Self

Get a flags value with all known bits set.

fn contains_unknown_bits(&self) -> bool

This method will return true if any unknown bits are set.

fn from_bits(bits: Self::Bits) -> Option<Self>

Convert from a bits value.

fn from_bits_truncate(bits: Self::Bits) -> Self

Convert from a bits value, unsetting any unknown bits.

fn from_name(name: &str) -> Option<Self>

Get a flags value with the bits of a flag with the given name set.

fn iter(&self) -> Iter<Self>

Yield a set of contained flags values.

fn iter_names(&self) -> IterNames<Self>

Yield a set of contained named flags values.

fn iter_defined_names() -> IterDefinedNames<Self>

Yield a set of all named flags defined by Self::FLAGS.

fn is_empty(&self) -> bool

Whether all bits in this flags value are unset.

fn is_all(&self) -> bool

Whether all known bits in this flags value are set.

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

where Self: Sized,

Whether any set bits in a source flags value are also set in a target flags value.

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

where Self: Sized,

Whether all set bits in a source flags value are also set in a target flags value.

fn truncate(&mut self)

where Self: Sized,

Remove any unknown bits from the flags.

fn insert(&mut self, other: Self)

where Self: Sized,

The bitwise or (|) of the bits in two flags values.

fn remove(&mut self, other: Self)

where Self: Sized,

The intersection of a source flags value with the complement of a target flags value (&!).

fn toggle(&mut self, other: Self)

where Self: Sized,

The bitwise exclusive-or (^) of the bits in two flags values.

fn set(&mut self, other: Self, value: bool)

where Self: Sized,

Call Flags::insert when value is true or Flags::remove when value is false.

fn clear(&mut self)

where Self: Sized,

Unsets all bits in the flags.

fn intersection(self, other: Self) -> Self

The bitwise and (&) of the bits in two flags values.

fn union(self, other: Self) -> Self

The bitwise or (|) of the bits in two flags values.

fn difference(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

fn symmetric_difference(self, other: Self) -> Self

The bitwise exclusive-or (^) of the bits in two flags values.

fn complement(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

impl FromIterator<PdfiumSearchFlags> for PdfiumSearchFlags

fn from_iter<T: IntoIterator<Item = Self>>(iterator: T) -> Self

The bitwise or (|) of the bits in each flags value.

impl Hash for PdfiumSearchFlags

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 IntoIterator for PdfiumSearchFlags

type Item = PdfiumSearchFlags

The type of the elements being iterated over.

type IntoIter = Iter<PdfiumSearchFlags>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl LowerHex for PdfiumSearchFlags

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

Formats the value using the given formatter.

impl Not for PdfiumSearchFlags

fn not(self) -> Self

The bitwise negation (!) of the bits in a flags value, truncating the result.

type Output = PdfiumSearchFlags

The resulting type after applying the ! operator.

impl Octal for PdfiumSearchFlags

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

Formats the value using the given formatter.

impl Ord for PdfiumSearchFlags

fn cmp(&self, other: &PdfiumSearchFlags) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for PdfiumSearchFlags

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

fn partial_cmp(&self, other: &PdfiumSearchFlags) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl PublicFlags for PdfiumSearchFlags

type Primitive = i32

The type of the underlying storage.

type Internal = InternalBitFlags

The type of the internal field on the generated flags type.

impl Sub for PdfiumSearchFlags

fn sub(self, other: Self) -> Self

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

type Output = PdfiumSearchFlags

The resulting type after applying the - operator.

impl SubAssign for PdfiumSearchFlags

fn sub_assign(&mut self, other: Self)

The intersection of a source flags value with the complement of a target flags value (&!).

This method is not equivalent to self & !other when other has unknown bits set. difference won’t truncate other, but the ! operator will.

impl UpperHex for PdfiumSearchFlags

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

Formats the value using the given formatter.

impl Copy for PdfiumSearchFlags

impl Eq for PdfiumSearchFlags

impl StructuralPartialEq for PdfiumSearchFlags