Skip to main content

Crate provenant

Crate provenant 

Source
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:

High-level crate organization:

  • scanner orchestrates traversal, filtering, and scan execution
  • parsers extracts package metadata from ecosystem-specific inputs
  • copyright and finder extract text clues such as copyrights, emails, and URLs
  • output renders ScanCode-compatible and SBOM-oriented output formats
  • models defines 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.