Expand description
§Provenant
provenant is the library crate behind the provenant CLI. It
provides ScanCode-compatible scanning, package parsing, and output-writing
building blocks for Rust applications.
The main entry points are:
processandprocess_with_optionsto scan a directory treeOutputFormat,OutputWriter, andwrite_output_fileto serialize scan resultsparsersandmodelsfor lower-level package parsing and result inspection
High-level crate organization:
scannerorchestrates traversal, filtering, and scan executionparsersextracts package metadata from ecosystem-specific inputscopyrightandfinderextract text clues such as copyrights, emails, and URLsoutputrenders ScanCode-compatible and SBOM-oriented output formatsmodelsdefines the core scan result data structures
User-facing installation, CLI usage, supported format coverage, and broader architecture notes live in the repository documentation. The crate-level rustdoc stays intentionally concise so fast-changing project details have a single source of truth outside this file.
Re-exports§
pub use models::ExtraData;pub use models::FileInfo;pub use models::FileType;pub use models::Header;pub use models::Output;pub use models::SystemEnvironment;pub use output::OutputFormat;pub use output::OutputWriteConfig;pub use output::OutputWriter;pub use output::write_output_file;pub use output::writer_for_format;pub use parsers::NpmParser;pub use parsers::PackageParser;pub use progress::ProgressMode;pub use progress::ScanProgress;pub use scanner::ProcessResult;pub use scanner::TextDetectionOptions;pub use scanner::count_with_size;pub use scanner::process;pub use scanner::process_with_options;
Modules§
- askalono
- assembly
- cache
- cli
- copyright
- Copyright detection module.
- finder
- golden_
maintenance - models
- output
- parsers
- progress
- scanner
- utils
Macros§
- register_
parser - Registers parser metadata for documentation generation.