Skip to main content

faf_rust_sdk/
lib.rs

1//! FAF Rust SDK - Foundational AI-context Format
2//!
3//! Fast, zero-copy parser for FAF files optimized for inference workloads.
4//!
5//! # Example
6//!
7//! ```rust
8//! use faf_rust_sdk::{parse, FafFile};
9//!
10//! let content = r#"
11//! faf_version: 2.5.0
12//! project:
13//!   name: my-project
14//!   goal: Build something great
15//! "#;
16//!
17//! let faf = parse(content).unwrap();
18//! println!("Project: {}", faf.project_name());
19//! ```
20
21pub mod binary;
22mod compress;
23mod discovery;
24mod parser;
25mod types;
26mod validator;
27
28#[cfg(feature = "axum")]
29pub mod axum;
30
31pub use binary::{FafbError, FafbHeader, Flags, Priority, SectionEntry, SectionTable, SectionType};
32pub use compress::{compress, estimate_tokens, CompressionLevel};
33pub use discovery::{find_and_parse, find_faf_file, FindError};
34pub use parser::{parse, parse_file, stringify, FafError, FafFile};
35pub use types::*;
36pub use validator::{validate, ValidationResult};
37
38/// Library version
39pub const VERSION: &str = env!("CARGO_PKG_VERSION");