sealmap-model 0.4.0

Language-neutral, deterministic code model (files, symbols, relations) for codebase-to-Mermaid generation
Documentation

sealmap-model

crates.io docs.rs

A language-neutral, deterministic model of a codebase: source files, the symbols they define, the typed relations between them, and the ordered call flow of every function. It is the shared vocabulary of sealmap: language adapters produce a Codebase, projections consume one, and neither side depends on the other.

  • sym: symbol ids: kind-explicit, SCIP-style, no file path (sym:cargo shop . db/Db#[Store]put().). Printing is injective and parsing is its exact inverse.
  • Fingerprints (Fingerprint): every symbol carries a sig_hash (its contract) and a body_hash (its implementation), so a tool can tell "unchanged", "behaviour changed" and "contract changed" apart.
  • Ordered collections only, so iteration order is a function of the data.
  • Normalised paths (SourcePath): relative, /-separated, no ./...
  • Stable hashing (ContentHash): BLAKE3 over newline-normalised text.
  • In-memory sources (SourceSet), loaded from disk honouring .gitignore, so tests and embedders never need the file system.
use sealmap_model::*;

let root = SymbolId::package_root(Package::current("cargo", "demo").unwrap());
let id = |name: &str| root.child(Descriptor::r#type(name)).unwrap();

let mut cb = Codebase::new("demo");
let file = SourcePath::new("src/lib.rs").unwrap();
cb.add_file(SourceFile::new(file.clone(), "rust", root.clone(), "pub struct A;"));
cb.add_symbol(Symbol::new(id("A"), "A", SymbolKind::Struct, file.clone()));
cb.add_symbol(Symbol::new(id("B"), "B", SymbolKind::Struct, file.clone()));
cb.add_relation(Relation::new(id("A"), id("B"), RelationKind::FieldType, Confidence::Exact));

assert_eq!(id("A").to_string(), "sym:cargo demo . A#");
assert_eq!(cb.symbols_in_file(&file).count(), 2);
assert_eq!(cb.relations_from(&id("A")).count(), 1);

Licence

Licensed under either of Apache License, Version 2.0 or MIT licence, at your option. Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 licence, shall be dual licensed as above, without any additional terms or conditions.