OverlappingState in regex_automata::dfa - Rust (original) (raw)
Struct OverlappingState
pub struct OverlappingState { /* private fields */ }Available on crate feature dfa-search and (crate features dfa-search or dfa-onepass) only.
Expand description
Represents the current state of an overlapping search.
This is used for overlapping searches since they need to know something about the previous search. For example, when multiple patterns match at the same position, this state tracks the last reported pattern so that the next search knows whether to report another matching pattern or continue with the search at the next position. Additionally, it also tracks which state the last search call terminated in.
This type provides little introspection capabilities. The only thing a caller can do is construct it and pass it around to permit search routines to use it to track state, and also ask whether a match has been found.
Callers should always provide a fresh state constructed viaOverlappingState::start when starting a new search. Reusing state from a previous search may result in incorrect results.
Create a new overlapping state that begins at the start state of any automaton.
Return the match result of the most recent search to execute with this state.
A searches will clear this result automatically, such that if no match is found, this will correctly report None.
Tests for self and other values to be equal, and is used by ==.
Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.