Enum SymbolKind 

pub enum SymbolKind {
    Struct,
    Enum,
    Function,
    Method,
    Trait,
    Impl,
    Mod,
    Const,
    Static,
    TypeAlias,
    Union,
    Macro,
    Variable,
    Parameter,
    Field,
    TupleField,
    Variant,
    Use,
    Any,
    Other,
}

Symbol type classification

This enum classifies symbols for analysis and search purposes. It extends AST-level item kinds with additional types for variables, parameters, and fields (InSymbol).

Design

Layer	Kind Type	Responsibility
AST (ryo-source)	ItemKind	Syntactic item classification (no Var)
Symbol (ryo-symbol)	SymbolKind	Analysis/search classification (includes Var)

Conversion from ItemKind is done via From trait implemented in the consuming crate (e.g., ryo-analysis), not here.

InSymbol Extensions

SymbolKind	VarScope	Path Example
Parameter	$param	my_crate::my_fn::$param::x
Variable	$var	my_crate::my_fn::$var::result
Field	$field	my_crate::MyStruct::$field::name

Variants

Struct

Struct definition

Enum

Enum definition

Function

Free function

Method

Method (in impl block)

Trait

Trait definition

Impl

Impl block

Mod

Module

Const

Constant

Static

Static variable

TypeAlias

Type alias

Union

Union type

Macro

Macro definition

Variable

Local variable ($var)

Parameter

Function/method parameter ($param)

Field

Struct/enum field ($field)

TupleField

Tuple struct/enum field (indexed: 0, 1, 2…)

Variant

Enum variant

Use

Use statement (import)

Any

Wildcard - matches any kind (for pattern matching)

Other

Unknown or unsupported

Implementations

impl SymbolKind

pub fn is_in_symbol(&self) -> bool

Check if this is an InSymbol kind (variable, parameter, or field)

pub fn is_type(&self) -> bool

Check if this is a type definition

pub fn is_callable(&self) -> bool

Check if this is callable

pub fn is_value(&self) -> bool

Check if this is a value (const, static, field, variable, parameter)

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

Get display name for this kind

pub fn is_any(&self) -> bool

Check if this is a wildcard that matches any kind

pub fn matches(&self, other: &SymbolKind) -> bool

Returns true if this matches the given kind (considering Any as wildcard).

Trait Implementations

impl Clone for SymbolKind

fn clone(&self) -> SymbolKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SymbolKind

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

Formats the value using the given formatter.

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

fn deserialize<__D>( __deserializer: __D, ) -> Result<SymbolKind, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SymbolKind

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

Formats the value using the given formatter.

impl Hash for SymbolKind

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

where __H: Hasher,

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 PartialEq for SymbolKind

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SymbolKind

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for SymbolKind

impl Eq for SymbolKind

impl StructuralPartialEq for SymbolKind