Struct FunctionFeatures 

pub struct FunctionFeatures {

    pub name: String,
    pub kind: String,
    pub start_line: usize,
    pub end_line: usize,
    pub start_column: usize,
    pub end_column: usize,
    pub start_byte: usize,
    pub end_byte: usize,
    pub parent: Option<usize>,
    pub token_count: usize,
    pub node_count: usize,
    pub depth: usize,
    pub exact_hashes: BTreeMap<Level, Hash128>,
    pub features: BTreeMap<Level, LevelFeatures>,
    pub tokens: Option<BTreeMap<Level, Vec<String>>>,
}

Features of one function unit.

Fields

name: String

Function name for display; <anonymous> for lambdas and blocks. Never used for matching.

kind: String

Tree-sitter node kind of the function.

start_line: usize

1-based, inclusive.

end_line: usize

Last line of the function (1-based, inclusive).

start_column: usize

1-based byte columns of the first and last character.

end_column: usize

1-based byte column of the last character.

start_byte: usize

Byte range in the file (0-based, end exclusive).

end_byte: usize

End of the byte range in the file (exclusive).

parent: Option<usize>

Index of the enclosing function in the same file.

token_count: usize

Number of N0 tokens.

node_count: usize

Number of named AST nodes (comments excluded).

depth: usize

Depth of the syntax tree of the function.

exact_hashes: BTreeMap<Level, Hash128>

Hash of the whole function at every normalization level.

features: BTreeMap<Level, LevelFeatures>

Present only for functions with at least min_tokens tokens.

tokens: Option<BTreeMap<Level, Vec<String>>>

Normalized tokens at every level, kept only with Config::keep_tokens.

Implementations

impl FunctionFeatures

pub fn is_indexed(&self) -> bool

Whether this function is large enough to carry fingerprints.

Examples

use pelicode_core::{Config, Language, extract_source};

let source = b"def area(w, h):\n    return w * h\n";
let small = Config { min_tokens: 100, ..Config::default() };
assert!(!extract_source(Language::Python, source, &small).unwrap()[0].is_indexed());
let all = Config { min_tokens: 0, ..Config::default() };
assert!(extract_source(Language::Python, source, &all).unwrap()[0].is_indexed());

Trait Implementations

impl Clone for FunctionFeatures

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 FunctionFeatures

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

Formats the value using the given formatter.

impl Serialize for FunctionFeatures

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

where __S: Serializer,

Serialize this value into the given Serde serializer.