Enum SymbolKind 

pub enum SymbolKind {
    Module,
    Struct,
    Enum,
    Union,
    Trait,
    TypeAlias,
    Function,
    Method,
    Const,
    Static,
    Macro,
}

What kind of thing a Symbol is.

The set is a superset of what common languages need; language adapters map their own constructs onto the closest variant (a TypeScript interface would be a SymbolKind::Trait, a Python class a SymbolKind::Struct).

Variants

Module

A module / namespace. Every source file has one.

Struct

A product type with named or positional fields.

Enum

A sum type.

Union

An untagged union.

Trait

An interface / trait / protocol.

TypeAlias

A type alias.

Function

A free function.

Method

A function attached to a type (inherent or trait method, including associated functions without self).

Const

A constant.

Static

A static / global variable.

Macro

A macro definition.

Implementations

impl SymbolKind

pub fn is_type(self) -> bool

true for kinds that are rendered as classes in a structure diagram.

pub fn is_callable(self) -> bool

true for kinds that have a body and therefore may carry a Flow.

pub fn descriptor(self, name: impl Into<String>) -> Descriptor

The sym: descriptor for a symbol of this kind called name: a namespace for modules, a type for structs, enums, unions, traits and aliases, a method for functions and methods, a term for constants and statics, a macro for macros.

assert_eq!(SymbolKind::Module.descriptor("net").suffix(), &sealmap_model::Suffix::Namespace);

pub fn keyword(self) -> &'static str

Lower-case keyword used in diagrams and metadata (struct, fn, …).

Trait Implementations

impl Clone for SymbolKind

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for SymbolKind

impl Debug for SymbolKind

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SymbolKind

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for SymbolKind

impl Hash for SymbolKind

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 SymbolKind

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 SymbolKind

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for SymbolKind

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 SymbolKind

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 SymbolKind