morel

Struct Finder

Source
pub struct Finder { /* private fields */ }
Expand description

Provides methods to search text.

Implementations§

Source§

impl Finder

Source

pub fn new(syntax: Syntax, a: Kind) -> Self

Create a new instance of Finder with the provided Syntax and Algorithm.

The Finder instance will use the algorithm described by Kind to search for patterns.

Source

pub fn next(&self, text: &str, at: usize) -> Option<(usize, usize, usize)>

Search the given text starting at ‘n’ for a match on any pattern of the given syntax.

§Examples
use morel::{Syntax, Finder, Kind};

// We want to search for these patterns.
// Each pattern has a unique (within the vec) identifier and a literal value.
let patterns = vec![(0, "abc".into()), (1, "def".into())];

// Patterns are cloned to allow for an assertion further down.
let syntax = Syntax::new(patterns.clone());
let mut finder = Finder::new(syntax, Kind::AhoCorasick);

// The text to be searched.
let text = "123abc";

let result = finder.next(text, 0);

// A match is found.
assert_eq!(result, Some((0, 3, 6)));

let unwrapped = result.unwrap();
let id = unwrapped.0;
let start = unwrapped.1;
let end = unwrapped.2;

// The text between the indices is equal to the pattern literal.
assert_eq!(
   &text[start..end],
   patterns.into_iter().find(|e| e.0 == id).unwrap().1
);
Source

pub fn starts(&self, text: &str, at: usize) -> Option<(usize, usize)>

Determine if the given text starting at ‘n’ begins with a match on any pattern of the given syntax.

§Examples
use morel::{Syntax, Finder, Kind};

// We want to search for these patterns.
// Each pattern has a unique (within the vec) identifier and a literal value.
let patterns = vec![(0, "abc".into()), (1, "def".into())];

// Patterns are cloned to allow for an assertion further down.
let syntax = Syntax::new(patterns.clone());
let finder = Finder::new(syntax, Kind::AhoCorasick);

// The text to be searched.
let text = "abc123";
let result = finder.starts(text, 0);

// A match is found.
assert_eq!(result, Some((0, 3)));

let unwrapped = result.unwrap();
let id = unwrapped.0;
let length = unwrapped.1;

// The text between the indices is equal to the pattern literal.
assert_eq!(
   &text[0..length],
   patterns.into_iter().find(|e| e.0 == id).unwrap().1
);

Trait Implementations§

Source§

impl Clone for Finder

Source§

fn clone(&self) -> Finder

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl Freeze for Finder

§

impl RefUnwindSafe for Finder

§

impl Send for Finder

§

impl Sync for Finder

§

impl Unpin for Finder

§

impl UnwindSafe for Finder

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<T> CloneToUninit for T
where T: Clone,

Source§

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

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dst. Read more
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> 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.