Struct Codebase 

pub struct Codebase {
    pub schema_version: u32,
    pub name: String,
    pub files: BTreeMap<SourcePath, SourceFile>,
    pub symbols: BTreeMap<SymbolId, Symbol>,
    pub relations: BTreeSet<Relation>,
}

The whole analysed codebase: files, symbols and relations.

All collections are ordered, so serialising a Codebase (for example with serde_json) is deterministic. Query methods return iterators in key order.

Fields

schema_version: u32

Schema version, see MODEL_SCHEMA_VERSION.

name: String

Human name of the codebase (workspace or package name).

files: BTreeMap<SourcePath, SourceFile>

Files keyed by path.

symbols: BTreeMap<SymbolId, Symbol>

Symbols keyed by id.

relations: BTreeSet<Relation>

All relations, ordered.

Implementations

impl Codebase

pub fn new(name: impl Into<String>) -> Self

An empty codebase called name.

pub fn from_json(text: &str) -> Result<Self, ModelJsonError>

Read a model serialised as JSON, refusing any schema version other than MODEL_SCHEMA_VERSION.

use sealmap_model::{Codebase, ModelJsonError};

let json = serde_json::to_string(&Codebase::new("demo")).unwrap();
assert_eq!(Codebase::from_json(&json).unwrap().name, "demo");

let v1 = r#"{"schema":1,"name":"old","files":{},"symbols":{},"relations":[]}"#;
assert!(matches!(Codebase::from_json(v1), Err(ModelJsonError::Version { found: Some(1), .. })));

pub fn add_file(&mut self, file: SourceFile)

Add or replace a file.

pub fn add_symbol(&mut self, symbol: Symbol)

Add a symbol. If the id already exists the two are merged: the first definition wins for scalar fields, list fields are concatenated, and the fingerprints are folded with Fingerprint::merge so an edit to either definition shows. This handles e.g. #[cfg]-gated duplicate definitions deterministically.

pub fn add_relation(&mut self, relation: Relation)

Add a relation (duplicates are ignored). Self-loops are dropped.

pub fn file(&self, path: &SourcePath) -> Option<&SourceFile>

Look up a file.

pub fn symbol(&self, id: &SymbolId) -> Option<&Symbol>

Look up a symbol.

pub fn is_internal(&self, id: &SymbolId) -> bool

true if id is defined inside the codebase.

pub fn symbols_in_file<'a>( &'a self, path: &'a SourcePath, ) -> impl Iterator<Item = &'a Symbol>

Symbols defined in path, in id order.

pub fn symbols_of_kind(&self, kind: SymbolKind) -> impl Iterator<Item = &Symbol>

Symbols of kind, in id order.

pub fn children<'a>( &'a self, id: &'a SymbolId, ) -> impl Iterator<Item = &'a Symbol>

Direct children of id (methods of a type, items of a module).

pub fn relations_from<'a>( &'a self, id: &'a SymbolId, ) -> impl Iterator<Item = &'a Relation>

Relations whose source is id.

Relation orders by from first, so this is a range scan (O(log n + k)), not a pass over every relation.

pub fn relations_to<'a>( &'a self, id: &'a SymbolId, ) -> impl Iterator<Item = &'a Relation>

Relations whose target is id.

pub fn relations_of_kind( &self, kind: RelationKind, ) -> impl Iterator<Item = &Relation>

Relations of one kind.

pub fn owner_of(&self, id: &SymbolId) -> Option<SymbolId>

The innermost type that owns id (the type for a method), or the module for free items. This is the “participant” a symbol belongs to in a sequence diagram.

For external ids the parent path is returned as-is.

pub fn stats(&self) -> CodebaseStats

Summary counts.

Trait Implementations

impl Clone for Codebase

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 Codebase

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

Formats the value using the given formatter.

impl Default for Codebase

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Codebase

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Codebase

impl PartialEq for Codebase

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Codebase

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 Codebase