regexr 0.1.2

A high-performance regex engine built from scratch with JIT compilation and SIMD acceleration
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98

//! PikeVM engine facade.
//!
//! Provides a unified interface for the PikeVM executor.
//! Since PikeVM doesn't have a JIT backend, this facade simply wraps the interpreter.

use crate::nfa::Nfa;

use super::interpreter::PikeVm;
use super::shared::PikeVmContext;

/// PikeVM engine that wraps the interpreter.
///
/// This is a thread-based NFA simulator that supports capture groups,
/// backreferences, and lookarounds.
pub struct PikeVmEngine {
    vm: PikeVm,
}

impl std::fmt::Debug for PikeVmEngine {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        f.debug_struct("PikeVmEngine").finish()
    }
}

impl PikeVmEngine {
    /// Creates a new PikeVM engine from an NFA.
    pub fn new(nfa: Nfa) -> Self {
        Self {
            vm: PikeVm::new(nfa),
        }
    }

    /// Returns true if the pattern matches anywhere in the input.
    #[inline]
    pub fn is_match(&self, input: &[u8]) -> bool {
        self.vm.is_match(input)
    }

    /// Finds the first match, returning (start, end).
    #[inline]
    pub fn find(&self, input: &[u8]) -> Option<(usize, usize)> {
        self.vm.find(input)
    }

    /// Finds a match starting at or after the given position.
    #[inline]
    pub fn find_at(&self, input: &[u8], pos: usize) -> Option<(usize, usize)> {
        self.vm.find_at(input, pos)
    }

    /// Returns capture groups for the first match.
    #[inline]
    pub fn captures(&self, input: &[u8]) -> Option<Vec<Option<(usize, usize)>>> {
        self.vm.captures(input)
    }

    /// Returns capture groups for a match known to start at position 0.
    #[inline]
    pub fn captures_from_start(&self, input: &[u8]) -> Option<Vec<Option<(usize, usize)>>> {
        self.vm.captures_from_start(input)
    }

    /// Creates a reusable context for this VM.
    pub fn create_context(&self) -> PikeVmContext {
        self.vm.create_context()
    }

    /// Returns capture groups using a pre-allocated context.
    #[inline]
    pub fn captures_from_start_with_context(
        &self,
        input: &[u8],
        ctx: &mut PikeVmContext,
    ) -> Option<Vec<Option<(usize, usize)>>> {
        self.vm.captures_from_start_with_context(input, ctx)
    }

    /// Returns capture groups using a pre-allocated context, starting from a given position.
    #[inline]
    pub fn captures_with_context(
        &self,
        input: &[u8],
        ctx: &mut PikeVmContext,
        start_pos: usize,
    ) -> Option<Vec<Option<(usize, usize)>>> {
        self.vm.captures_with_context(input, ctx, start_pos)
    }

    /// Returns a reference to the underlying PikeVm.
    pub fn vm(&self) -> &PikeVm {
        &self.vm
    }

    /// Returns whether JIT is being used (always false for PikeVM).
    pub fn is_jit(&self) -> bool {
        false
    }
}