fynx_platform/
lib.rs

1//! # Fynx Platform
2//!
3//! Core platform types, traits, and utilities for the Fynx security ecosystem.
4//!
5//! This crate provides:
6//! - Unified error types (`FynxError`, `FynxResult`)
7//! - Core traits (`SecurityModule`, `ProtocolStack`, `Scanner`, `Analyzer`)
8//! - Common utilities and configuration
9//!
10//! # Examples
11//!
12//! ```
13//! use fynx_platform::{FynxError, FynxResult};
14//!
15//! fn example_function() -> FynxResult<String> {
16//!     Ok("Hello, Fynx!".to_string())
17//! }
18//!
19//! # fn main() -> FynxResult<()> {
20//! let result = example_function()?;
21//! assert_eq!(result, "Hello, Fynx!");
22//! # Ok(())
23//! # }
24//! ```
25
26#![warn(missing_docs)]
27#![warn(rust_2018_idioms)]
28#![forbid(unsafe_code)]
29
30pub mod error;
31pub mod traits;
32
33pub use error::{FynxError, FynxResult};
34pub use traits::{
35    AnalysisResult, Analyzer, Finding, Match, ScanResult, Scanner, SecurityModule, Severity,
36};
37
38/// Platform version
39pub const VERSION: &str = env!("CARGO_PKG_VERSION");