Skip to main content

EntityDetector

Struct EntityDetector 

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

Entity-aware detector using regex patterns plus check-digit validation where applicable.

PANs are validated with Luhn; CPFs and CNPJs with the Brazilian mod-11 algorithm. This sharply reduces false positives on random numeric strings (invoice numbers, order IDs, etc.) that share the same shape as real identifiers.

A RegexSet prefilter runs first: one multi-pattern pass identifies which categories appear at all, so a clean string (the common case) pays a single scan instead of eight independent find_iter passes.

Implementations§

Source§

impl EntityDetector

Source

pub fn new(enabled: CategorySet) -> Result<Self, Error>

Construct a detector with an explicit category toggle set.

§Errors

Returns a regex::Error if any internal pattern fails to compile.

Source

pub fn baseline() -> Result<Self, Error>

Baseline detector with all categories enabled.

§Errors

See EntityDetector::new.

Trait Implementations§

Source§

impl Debug for EntityDetector

Source§

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

Formats the value using the given formatter. Read more
Source§

impl PiiDetector for EntityDetector

Source§

fn detect(&self, text: &str) -> Vec<PiiSpan>

Find every PII span in text. Returned spans use UTF-8 char-boundary-safe byte offsets.

Auto Trait Implementations§

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> 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, 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.