Trait PackageParser

Source

pub trait PackageParser {
    const PACKAGE_TYPE: PackageType;

    // Required methods
    fn extract_packages(path: &Path) -> Vec<PackageData>;
    fn is_match(path: &Path) -> bool;

    // Provided method
    fn extract_first_package(path: &Path) -> PackageData { ... }
}

Expand description

Package parser trait for extracting metadata from package manifest files.

Each parser implementation handles a specific package manager/ecosystem (npm, Maven, Python, Cargo, etc.) and extracts standardized metadata into PackageData structures compatible with ScanCode Toolkit JSON output format.

§Implementation Guide

Implementors must provide:

PACKAGE_TYPE: Package URL (purl) type identifier (e.g., “npm”, “pypi”, “maven”)
is_match(): Returns true if the given file path matches this parser’s expected format
extract_packages(): Parses the file and returns all extracted package metadata

§Error Handling

Parsers should handle errors gracefully by returning default/empty PackageData and logging warnings with crate::parser_warn! rather than panicking. Scanner dispatch captures those warnings and attaches them to FileInfo.scan_errors so CI output and serialized scan results stay aligned. This allows the scan to continue processing other files even when individual files fail to parse.

§Example

use provenant::models::{PackageData, PackageType};
use provenant::parsers::PackageParser;
use std::path::Path;

pub struct MyParser;

impl PackageParser for MyParser {
    const PACKAGE_TYPE: PackageType = PackageType::Npm;

    fn is_match(path: &Path) -> bool {
        path.file_name().is_some_and(|name| name == "package.json")
    }

    fn extract_packages(path: &Path) -> Vec<PackageData> {
        vec![PackageData::default()]
    }
}

Required Associated Constants§

Source

const PACKAGE_TYPE: PackageType

Package URL type identifier for this parser (e.g., PackageType::Npm, PackageType::Pypi).

Required Methods§

Source

fn extract_packages(path: &Path) -> Vec<PackageData>

Extracts all packages from the given file path.

Returns a vector of PackageData structures containing all extracted metadata including name, version, dependencies, licenses, etc. Most parsers return a single-element vector, but some (e.g., Bazel BUILD, Buck BUCK, Debian control) can contain multiple packages in a single file.

On parse errors, returns a vector with a default PackageData with minimal or no fields populated.

Source

fn is_match(path: &Path) -> bool

Checks if the given file path matches this parser’s expected format.

Returns true if the file should be handled by this parser based on filename, extension, or path patterns. Used by the scanner to route files to appropriate parsers.

Provided Methods§

Source

fn extract_first_package(path: &Path) -> PackageData

Returns the first package from extract_packages(), or a default PackageData if the file contains no packages.

Dyn Compatibility§

This trait is not dyn compatible.

In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.

Trait PackageParser Copy item path

§Implementation Guide

§Error Handling

§Example

Required Associated Constants§

const PACKAGE_TYPE: PackageType

Required Methods§

fn extract_packages(path: &Path) -> Vec<PackageData>

fn is_match(path: &Path) -> bool

Provided Methods§

fn extract_first_package(path: &Path) -> PackageData

Dyn Compatibility§

Implementors§

impl PackageParser for AboutFileParser

const PACKAGE_TYPE: PackageType = PackageType::About

impl PackageParser for AlpineApkParser

const PACKAGE_TYPE: PackageType = PACKAGE_TYPE

impl PackageParser for AlpineApkbuildParser

const PACKAGE_TYPE: PackageType = PACKAGE_TYPE

impl PackageParser for AlpineInstalledParser

const PACKAGE_TYPE: PackageType = PACKAGE_TYPE

impl PackageParser for AndroidApkRecognizer

const PACKAGE_TYPE: PackageType = PackageType::Android

impl PackageParser for AndroidLibraryRecognizer

const PACKAGE_TYPE: PackageType = PackageType::AndroidLib

impl PackageParser for AppleDmgRecognizer

const PACKAGE_TYPE: PackageType = PackageType::Dmg

impl PackageParser for ArchPkginfoParser

const PACKAGE_TYPE: PackageType = PACKAGE_TYPE

impl PackageParser for ArchSrcinfoParser

const PACKAGE_TYPE: PackageType = PACKAGE_TYPE

impl PackageParser for AutotoolsConfigureParser

const PACKAGE_TYPE: PackageType = PackageType::Autotools

impl PackageParser for Axis2MarRecognizer

const PACKAGE_TYPE: PackageType = PackageType::Axis2

impl PackageParser for Axis2ModuleXmlRecognizer

const PACKAGE_TYPE: PackageType = PackageType::Axis2

impl PackageParser for BazelBuildParser

const PACKAGE_TYPE: PackageType = PackageType::Bazel

impl PackageParser for BazelModuleParser

const PACKAGE_TYPE: PackageType = PackageType::Bazel

impl PackageParser for BowerJsonParser

const PACKAGE_TYPE: PackageType = PackageType::Bower

impl PackageParser for BuckBuildParser

const PACKAGE_TYPE: PackageType = PackageType::Buck

impl PackageParser for BuckMetadataBzlParser

const PACKAGE_TYPE: PackageType = PackageType::Buck

impl PackageParser for BunLockParser

const PACKAGE_TYPE: PackageType = PackageType::Npm

impl PackageParser for BunLockbParser

const PACKAGE_TYPE: PackageType = PackageType::Npm

impl PackageParser for CabArchiveRecognizer

const PACKAGE_TYPE: PackageType = PackageType::Cab

impl PackageParser for CargoLockParser

const PACKAGE_TYPE: PackageType = PackageType::Cargo

impl PackageParser for CargoParser

const PACKAGE_TYPE: PackageType = PackageType::Cargo

impl PackageParser for CentralPackageManagementPropsParser

const PACKAGE_TYPE: PackageType = PackageType::Nuget

impl PackageParser for ChefMetadataJsonParser

const PACKAGE_TYPE: PackageType = PackageType::Chef

impl PackageParser for ChefMetadataRbParser

const PACKAGE_TYPE: PackageType = PackageType::Chef

impl PackageParser for ChromeCrxRecognizer

const PACKAGE_TYPE: PackageType = PackageType::Chrome

impl PackageParser for CitationCffParser

const PACKAGE_TYPE: PackageType = PackageType::Generic

impl PackageParser for ClojureDepsEdnParser

const PACKAGE_TYPE: PackageType = PackageType::Maven

impl PackageParser for ClojureProjectCljParser

const PACKAGE_TYPE: PackageType = PackageType::Maven

impl PackageParser for ComposerJsonParser

const PACKAGE_TYPE: PackageType = PackageType::Composer

impl PackageParser for ComposerLockParser

const PACKAGE_TYPE: PackageType = PackageType::Composer

impl PackageParser for ConanDataParser

const PACKAGE_TYPE: PackageType = PACKAGE_TYPE

impl PackageParser for ConanFilePyParser

const PACKAGE_TYPE: PackageType = PackageType::Conan

impl PackageParser for ConanLockParser

Trait PackageParser