cairo-language-server 2.19.0-rc.2

The Cairo Language Server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

use cairo_lang_defs::ids::{NamedLanguageElementId, VariantId};
use cairo_lang_syntax::node::ids::SyntaxStablePtrId;
use cairo_lang_syntax::node::{SyntaxNode, TypedSyntaxNode, ast};

use crate::lang::db::AnalysisDatabase;
use crate::lang::defs::ItemDef;

/// Information about an enum variant.
#[derive(Eq, PartialEq, Debug, Clone)]
pub struct VariantDef<'db> {
    variant_id: VariantId<'db>,
    enum_item: ItemDef<'db>,
    definition_stable_ptr: SyntaxStablePtrId<'db>,
}

impl<'db> VariantDef<'db> {
    /// Constructs a new [`VariantDef`] instance.
    pub(super) fn new(
        db: &'db AnalysisDatabase,
        variant_id: VariantId<'db>,
        definition_node: SyntaxNode<'db>,
    ) -> Option<Self> {
        let enum_ast = definition_node.ancestor_of_type::<ast::ItemEnum>(db)?;
        let enum_item = ItemDef::new(db, enum_ast.name(db).as_syntax_node())?;
        Some(Self { variant_id, enum_item, definition_stable_ptr: definition_node.stable_ptr(db) })
    }

    /// Gets the stable pointer to the syntax node which defines this symbol.
    pub fn definition_stable_ptr(&self) -> SyntaxStablePtrId<'db> {
        self.definition_stable_ptr
    }

    /// Gets [`VariantId`] associated with this symbol.
    pub fn variant_id(&self) -> VariantId<'db> {
        self.variant_id
    }

    /// Gets a definition of the enum which this symbol is a variant of.
    pub fn enum_item(&self) -> &ItemDef<'db> {
        &self.enum_item
    }

    /// Gets variant's name.
    pub fn name(&self, db: &'db AnalysisDatabase) -> String {
        self.variant_id.name(db).to_string(db)
    }
}