Struct LicenseDetectionEngine 

pub struct LicenseDetectionEngine { /* private fields */ }

License detection engine that orchestrates the detection pipeline.

The engine loads license rules and builds an index for efficient matching. It supports multiple matching strategies (hash, SPDX-LID, Aho-Corasick, sequence) and combines their results into final license detections.

Implementations

impl LicenseDetectionEngine

pub fn from_embedded() -> Result<Self>

Create a new license detection engine from the embedded license index.

Convenience method that uses the default Provenant cache root and does not force a reindex.

pub fn from_embedded_with_cache( cache_config: &LicenseCacheConfig, ) -> Result<Self>

Create a new license detection engine from the embedded license index.

This method loads the build-time embedded license artifact and constructs the runtime license index. This eliminates the runtime dependency on the ScanCode rules directory.

If a valid cache exists (matching fingerprint), the index is loaded from the rkyv cache file instead of being rebuilt from scratch.

Arguments

• cache_config - Cache configuration (directory and reindex flag)

Returns

A Result containing the engine or an error

pub fn from_directory(rules_path: &Path) -> Result<Self>

Create a new license detection engine from a license dataset root.

Convenience method that uses the default Provenant cache root and does not force a reindex.

pub fn from_directory_with_cache( rules_path: &Path, cache_config: &LicenseCacheConfig, ) -> Result<Self>

Create a new license detection engine from a directory of license rules.

If a valid cache exists (matching fingerprint of the dataset), the index is loaded from the rkyv cache file instead of being rebuilt from scratch.

Arguments

• rules_path - Path to dataset root containing rules/ and licenses/
• cache_config - Cache configuration (directory and reindex flag)

Returns

A Result containing the engine or an error

pub fn embedded_spdx_license_list_version() -> Result<String>

pub fn detect_with_kind( &self, text: &str, unknown_licenses: bool, binary_derived: bool, ) -> Result<Vec<LicenseDetection>>

pub fn detect_with_kind_with_score( &self, text: &str, unknown_licenses: bool, binary_derived: bool, min_score: f32, ) -> Result<Vec<LicenseDetection>>

pub fn detect_with_kind_and_source( &self, text: &str, unknown_licenses: bool, binary_derived: bool, source_path: &str, ) -> Result<Vec<LicenseDetection>>

pub fn detect_with_kind_and_source_with_score( &self, text: &str, unknown_licenses: bool, binary_derived: bool, source_path: &str, min_score: f32, ) -> Result<Vec<LicenseDetection>>

pub fn index(&self) -> &LicenseIndex

Get a reference to the license index.

pub fn spdx_license_list_version(&self) -> Option<&str>

pub fn license_index_provenance(&self) -> Option<&LicenseIndexProvenance>

Trait Implementations

impl Clone for LicenseDetectionEngine

fn clone(&self) -> LicenseDetectionEngine

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LicenseDetectionEngine

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

Formats the value using the given formatter.