redact-core 0.8.3

Core PII detection and anonymization engine - Presidio replacement
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

// Copyright 2026 Censgate LLC.
// Licensed under the Apache License, Version 2.0. See the LICENSE file
// in the project root for license information.

//! Redact Core - PII Detection and Anonymization Engine
//!
//! A high-performance, Rust-based PII detection and anonymization library
//! designed as a replacement for Microsoft Presidio.
//!
//! # Features
//!
//! - **Pattern-based Detection**: Regex-based PII recognizers for structured data
//! - **NER Support**: Named Entity Recognition using ONNX Runtime (via redact-ner)
//! - **Multiple Anonymization Strategies**: Replace, mask, hash, encrypt
//! - **Policy-Aware**: Configurable rules and thresholds
//! - **Multi-platform**: Server, WASM, mobile support
//! - **High Performance**: Zero-copy where possible, efficient overlap resolution
//!
//! # Example
//!
//! ```no_run
//! use redact_core::{AnalyzerEngine, AnonymizerConfig, AnonymizationStrategy};
//!
//! let mut analyzer = AnalyzerEngine::new();
//!
//! let text = "Contact John Doe at john@example.com or 555-1234";
//! let result = analyzer.analyze(text, None).unwrap();
//!
//! println!("Detected {} entities", result.detected_entities.len());
//!
//! // Anonymize with replacement strategy
//! let config = AnonymizerConfig {
//!     strategy: AnonymizationStrategy::Replace,
//!     ..Default::default()
//! };
//! let anonymized = analyzer.anonymize(text, None, &config).unwrap();
//! println!("Anonymized: {}", anonymized.text);
//! ```

pub mod anonymizers;
pub mod engine;
pub mod policy;
pub mod recognizers;
pub mod types;

// Re-export commonly used types
pub use anonymizers::{AnonymizationStrategy, AnonymizerConfig, AnonymizerRegistry};
pub use engine::AnalyzerEngine;
pub use recognizers::{Recognizer, RecognizerRegistry};
pub use types::{
    AnalysisMetadata, AnalysisResult, AnonymizedResult, EntityType, RecognizerResult, Token,
};

/// Version of the redact-core library
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_version() {
        assert!(!VERSION.is_empty());
    }
}