Struct SpdxMapping 

pub struct SpdxMapping { /* private fields */ }

Mapping between ScanCode and SPDX license keys.

This structure enables conversion of license expressions from ScanCode-specific license keys (lowercase, e.g., “mit”, “gpl-2.0-plus”) to SPDX license identifiers (case-sensitive, e.g., “MIT”, “GPL-2.0-or-later”) and vice versa.

Implementations

impl SpdxMapping

pub fn build_from_licenses(licenses: &[License]) -> Self

Build an SPDX mapping from a slice of License objects.

This function extracts the spdx_license_key field from each License and builds the two-way mapping. For licenses without an SPDX equivalent, they are mapped to LicenseRef-scancode-<key> format.

Arguments

• licenses - Slice of License objects to build mapping from

Returns

A SpdxMapping with populated mappings

pub fn scancode_to_spdx(&self, scancode_key: &str) -> Option<String>

Convert a ScanCode license key to its SPDX equivalent.

Arguments

• scancode_key - Lowercase ScanCode license key (e.g., “mit”, “gpl-2.0-plus”)

Returns

Option containing SPDX license identifier, or None if key not found

pub fn expression_scancode_to_spdx( &self, scancode_expr: &str, ) -> Result<String, String>

Convert a license expression from ScanCode keys to SPDX keys.

This function parses the expression, replaces each license key with its SPDX equivalent, and serializes the result back to a string.

Arguments

• scancode_expr - License expression string with ScanCode keys

Returns

String containing the expression with SPDX keys, or parse error

Example

use provenant::license_detection::spdx_mapping::build_spdx_mapping;
use provenant::license_detection::models::License;

let licenses = vec![
    License {
        key: "mit".to_string(),
        name: "MIT License".to_string(),
        spdx_license_key: Some("MIT".to_string()),
        ..Default::default()
    },
    License {
        key: "gpl-2.0-plus".to_string(),
        name: "GPL 2.0+".to_string(),
        ..Default::default()
    },
];
let mapping = build_spdx_mapping(&licenses);
let spdx_expr = mapping.expression_scancode_to_spdx("mit OR gpl-2.0-plus").unwrap();
assert_eq!(spdx_expr, "LicenseRef-scancode-gpl-2.0-plus OR MIT");

Trait Implementations

impl Clone for SpdxMapping

fn clone(&self) -> SpdxMapping

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SpdxMapping

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.