Struct SymbolId 

pub struct SymbolId(/* private fields */);

The canonical, fully qualified identity of a symbol, e.g. my_crate::net::Client or my_crate::net::Client::connect.

Ids use :: as the separator for every language so projections can treat them uniformly. They are the join key between the model, the rendered diagrams and the JSON metadata, so an agent can follow an id from a node in a diagram straight back to its definition.

Symbols that live outside the analysed codebase (standard library, third party crates, or anything the frontend could not resolve) still get an id; they are simply absent from Codebase::symbols and relations pointing at them carry Confidence::External.

Implementations

impl SymbolId

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

Wrap a fully qualified path.

pub fn as_str(&self) -> &str

The id as a string.

pub fn name(&self) -> &str

The last :: segment (the short name).

assert_eq!(SymbolId::new("a::b::C").name(), "C");

pub fn parent(&self) -> Option<SymbolId>

The id with the last segment removed, if there is more than one.

assert_eq!(SymbolId::new("a::b::C").parent().unwrap().as_str(), "a::b");
assert!(SymbolId::new("a").parent().is_none());

pub fn child(&self, segment: &str) -> SymbolId

Append a segment: a::b + c → a::b::c.

Trait Implementations

impl Clone for SymbolId

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 SymbolId

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SymbolId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SymbolId

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

Formats the value using the given formatter.

impl Eq for SymbolId

impl Hash for SymbolId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for SymbolId

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for SymbolId

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SymbolId

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for SymbolId

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 SymbolId