pub struct RegexDetector { /* private fields */ }Expand description
Regex-backed Recognizer implementation.
Construct via RegexDetector::emails for the bundled email recognizer, or
supply a custom pattern through the rulepack mechanism. Patterns use Rust
regex syntax: no lookahead, lookbehind, or backreferences. Prefer TOML
literal strings ('...') in policy files to avoid double-escaping.
Candidate::span uses byte ranges, not char indices.
Implementations§
Source§impl RegexDetector
impl RegexDetector
pub fn new(pattern: &str, class: PiiClass) -> Result<Self>
pub fn with_source(pattern: &str, class: PiiClass, source: &str) -> Result<Self>
pub fn with_rulepack_fields( pattern: &str, class: PiiClass, source: &str, locales: Vec<LocaleTag>, base_score: f32, priority: i32, token_family: &str, capture_groups: Option<Vec<u32>>, exclusions: Vec<String>, validator_kind: Option<ValidatorKind>, normalizer_kind: Option<NormalizerKind>, ) -> Result<Self>
pub fn emails() -> Result<Self>
Trait Implementations§
Source§impl Detector for RegexDetector
impl Detector for RegexDetector
Source§impl Recognizer for RegexDetector
impl Recognizer for RegexDetector
Source§fn supported_class(&self) -> &PiiClass
fn supported_class(&self) -> &PiiClass
PII class supported by this recognizer.
Source§fn detect(
&self,
input: &str,
_ctx: &DetectContext<'_>,
) -> Result<Vec<Candidate>, DetectError>
fn detect( &self, input: &str, _ctx: &DetectContext<'_>, ) -> Result<Vec<Candidate>, DetectError>
Detects PII candidates in the supplied input and context.
Source§fn token_family(&self) -> &str
fn token_family(&self) -> &str
Token family used for candidate token emission.
Source§fn validator_kind(&self) -> Option<ValidatorKind>
fn validator_kind(&self) -> Option<ValidatorKind>
Optional validator kind used by pre-resolver validator-veto.
Auto Trait Implementations§
impl Freeze for RegexDetector
impl RefUnwindSafe for RegexDetector
impl Send for RegexDetector
impl Sync for RegexDetector
impl Unpin for RegexDetector
impl UnsafeUnpin for RegexDetector
impl UnwindSafe for RegexDetector
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Converts
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Converts
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Converts
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Converts
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
impl<T> ErasedDestructor for Twhere
T: 'static,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more