Struct Scanner 

pub struct Scanner<'a, B: BinaryView> { /* private fields */ }

Pattern scanner over a BinaryView.

Implementations

impl<'a, B: BinaryView> Scanner<'a, B>

pub fn new(view: &'a B) -> Self

Creates a scanner for a binary view.

pub fn finds_code(&self, pat: &[Atom], save: &mut [Offset]) -> bool

Returns true only when the pattern has exactly one code match.

pub fn required_slots(&self, pat: &[Atom]) -> usize

Returns the minimum required save-slot buffer length for pat.

Allocate at least this many elements before calling Self::finds_code or Self::matches_code/Matches::next.

Patterns produced by pattern::parse and pattern! always require at least one slot because they include an implicit Save(0) base capture.

pub fn prepare_pattern(&self, pat: &[Atom]) -> PreparedPattern

Prepares reusable scanner metadata for a parsed pattern.

pub fn prepare_pattern_str( &self, source: &str, ) -> Result<PreparedPattern, ParsePatError>

Parses and prepares a pattern string for scanning.

This is slower than Self::prepare_pattern because it performs runtime text parsing and allocates atom storage on each call.

pub fn finds_prepared(&self, pat: &PreparedPattern, save: &mut [Offset]) -> bool

Returns true only when a prepared pattern has exactly one code match.

pub fn matches_prepared<'p>( &self, pat: &'p PreparedPattern, ) -> Matches<'a, 'p, B>

Returns an iterator-like matcher for a prepared pattern.

pub fn matches_code<'p>(&self, pat: &'p [Atom]) -> Matches<'a, 'p, B>

Returns an iterator-like matcher for all code-range matches.

save buffers passed to Matches::next must be at least self.required_slots(pat) elements long.

Trait Implementations

impl<'a, B: Clone + BinaryView> Clone for Scanner<'a, B>

fn clone(&self) -> Scanner<'a, B>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, B: Debug + BinaryView> Debug for Scanner<'a, B>

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

Formats the value using the given formatter.

impl<'a, B: Copy + BinaryView> Copy for Scanner<'a, B>