Struct Candidate 

pub struct Candidate {
    pub kind: MatchKind,
    pub similarity: f64,
    pub containment: f64,
    pub package_count: Option<usize>,
    pub shared_fingerprints: usize,
    pub matched_lines: Vec<(u32, u32)>,
    pub candidate_lines: Vec<(u32, u32)>,
    pub function: FunctionInfo,
    pub occurrences: Vec<Occurrence>,
    pub occurrence_count: usize,
    pub database: usize,
}

A stored function similar to a checked function.

Fields

kind: MatchKind

How the candidate matched.

similarity: f64

1.0 for exact matches; the (weighted) Jaccard similarity of fingerprint sets otherwise.

containment: f64

(Weighted) share of the checked function’s fingerprints found in the candidate.

package_count: Option<usize>

For exact matches, the number of packages containing the same normalized function.

shared_fingerprints: usize

Number of fingerprints the two functions share, common ones excluded.

matched_lines: Vec<(u32, u32)>

Lines of the checked function covered by shared fingerprints.

candidate_lines: Vec<(u32, u32)>

Lines of the candidate covered by shared fingerprints.

function: FunctionInfo

The stored function.

occurrences: Vec<Occurrence>

Where the candidate appears, earliest publication first (at most max_occurrences).

occurrence_count: usize

Number of places the stored function was found, excluded packages aside.

database: usize

Position of the database of the candidate in the detectors given to detect_all; function.id is an id in that database.

Trait Implementations

impl Clone for Candidate

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 Candidate

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

Formats the value using the given formatter.

impl Serialize for Candidate

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.