llm-shield-core 0.1.0

Core types and traits for LLM Shield security toolkit
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

//! # LLM Shield Core
//!
//! Core types, traits, and utilities for the LLM Shield security toolkit.
//!
//! ## SPARC Methodology - Specification Phase
//!
//! This module defines the core abstractions for the LLM Shield system:
//! - `Scanner`: Core trait for all security scanners
//! - `ScanResult`: Standardized result type
//! - `Risk`: Risk assessment types
//! - `Error`: Comprehensive error handling
//!
//! ## Enterprise-Grade Design Principles
//!
//! 1. **Type Safety**: Strong typing throughout
//! 2. **Async-First**: All scanners support async operations
//! 3. **Composability**: Scanners can be chained and combined
//! 4. **Observability**: Comprehensive tracing and metrics
//! 5. **Error Context**: Rich error types with context

pub mod error;
pub mod result;
pub mod scanner;
pub mod types;
pub mod vault;

// Re-exports for convenience
pub use async_trait::async_trait;
pub use error::{Error, Result};
pub use result::{Entity, RiskFactor, ScanResult, Severity};
pub use scanner::{InputScanner, OutputScanner, Scanner, ScannerType};
pub use types::{ScannerConfig, ScannerMetadata};
pub use vault::Vault;

/// Version information
pub const VERSION: &str = env!("CARGO_PKG_VERSION");

/// Library initialization
pub fn init() {
    tracing_subscriber::fmt()
        .with_target(false)
        .with_thread_ids(true)
        .init();
}

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

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