Struct ContextReport 

pub struct ContextReport {

    pub target: Target,
    pub candidates: Vec<String>,
    pub signature: Option<String>,
    pub doc: Option<String>,
    pub lines: Option<(u32, u32)>,
    pub source: Option<String>,
    pub file: String,
    pub owner: Option<String>,
    pub callers: Vec<CallSites>,
    pub callers_not_shown: usize,
    pub callees: Vec<(String, u32)>,
    pub importers: Vec<String>,
    pub imports: Vec<String>,
    pub partners: Vec<(String, f64)>,
    pub recent_commits: Vec<(String, i64, String)>,
    pub notes: Vec<(String, String)>,
    pub concepts: Vec<(String, String)>,
}

One file or symbol, from every side the graph can see it.

Fields

target: Target

candidates: Vec<String>

Symbol keys sharing the bare name that was asked for. Non-empty only when the name was ambiguous, and then nothing else is filled in.

signature: Option<String>

doc: Option<String>

lines: Option<(u32, u32)>

(first line, last line) of a symbol, as extraction recorded them.

source: Option<String>

At most MAX_SOURCE_LINES lines from the working tree. None when the caller did not ask for a body (ContextOptions::source), when no repository path is known, or when the file cannot be read there.

file: String

The file itself, or the file a symbol is defined in.

owner: Option<String>

The file’s top author, by name.

callers: Vec<CallSites>

Every call site into the target, grouped by the file the calls sit in, most call sites first. See CallSites.

callers_not_shown: usize

How many caller files [MAX_CALLER_FILES] left out of callers.

callees: Vec<(String, u32)>

(symbol, the line it is called from), sorted by key.

importers: Vec<String>

imports: Vec<String>

partners: Vec<(String, f64)>

(file, co-change score), strongest first.

recent_commits: Vec<(String, i64, String)>

(sha, timestamp, subject), newest first.

notes: Vec<(String, String)>

(note key, text) for the notes written about it.

concepts: Vec<(String, String)>

(concept key, name) for the concepts learned from its file.

Trait Implementations

impl Clone for ContextReport

fn clone(&self) -> ContextReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContextReport

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

Formats the value using the given formatter.

impl PartialEq for ContextReport

fn eq(&self, other: &ContextReport) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for ContextReport

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ContextReport