Struct Options 

pub struct Options {
    pub min_tokens: usize,
    pub threshold: f64,
    pub max_candidates: usize,
    pub max_occurrences: usize,
    pub exclude_packages: Vec<(String, String)>,
    pub stop_packages: usize,
    pub min_shared: usize,
    pub idf: bool,
    pub dependencies: Dependencies,
}

Parameters of the search.

Examples

use pelicode_detect::Options;

let options = Options { threshold: 0.5, stop_packages: 0, ..Options::default() };
assert_eq!(options.max_candidates, 5);

Fields

min_tokens: usize

Functions with fewer tokens are not checked.

threshold: f64

Minimum Jaccard similarity of fingerprint sets to report a candidate.

max_candidates: usize

Candidates reported per function.

max_occurrences: usize

Occurrences listed per candidate.

exclude_packages: Vec<(String, String)>

Packages whose functions are never reported, as (ecosystem, name).

stop_packages: usize

Hashes found in at least this many packages are ignored (0 disables). Needs the statistics of Database::refresh_hash_stats.

min_shared: usize

Minimum number of shared (non-common) fingerprints for a similar match. Without it, a function whose fingerprints are almost all common could reach a high similarity through one or two remaining ones.

idf: bool

Weight fingerprints by inverse document frequency, ln(1 + N / df), where N is the number of packages and df those containing the fingerprint.

dependencies: Dependencies

Packages the checked code depends on (see dependencies): candidates found only in them are not reported, and their occurrences are left out of the other candidates.

Trait Implementations

impl Clone for Options

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Options

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

Formats the value using the given formatter.

impl Default for Options

fn default() -> Self

Returns the “default value” for a type.