cairo-lang-doc 2.18.0

A collection of documentation processing utilities for the Cairo programming language.
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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

use cairo_lang_defs::diagnostic_utils::StableLocation;
use cairo_lang_defs::ids::{
    LanguageElementId, LookupItemId, MemberId, NamedLanguageElementId, VariantId,
};
use cairo_lang_filesystem::ids::{CrateId, SmolStrId};
use salsa::Database;

/// Item whose documentation can be fetched from source code.
#[derive(Copy, Clone, Debug, Hash, Eq, PartialEq, salsa::Update)]
pub enum DocumentableItemId<'db> {
    Crate(CrateId<'db>),
    LookupItem(LookupItemId<'db>),
    Member(MemberId<'db>),
    Variant(VariantId<'db>),
}

impl<'db> DocumentableItemId<'db> {
    pub fn stable_location(&self, db: &'db dyn Database) -> Option<StableLocation<'db>> {
        match self {
            DocumentableItemId::Crate(_) => None,
            DocumentableItemId::LookupItem(lookup_item_id) => {
                Some(lookup_item_id.stable_location(db))
            }
            DocumentableItemId::Member(member_id) => Some(member_id.stable_location(db)),
            DocumentableItemId::Variant(variant_id) => Some(variant_id.stable_location(db)),
        }
    }

    /// Gets the name of the item.
    pub fn name(&self, db: &'db dyn Database) -> SmolStrId<'db> {
        match self {
            DocumentableItemId::LookupItem(LookupItemId::ModuleItem(id)) => id.name(db),
            DocumentableItemId::LookupItem(LookupItemId::ImplItem(id)) => id.name(db),
            DocumentableItemId::LookupItem(LookupItemId::TraitItem(id)) => id.name(db),
            DocumentableItemId::Crate(id) => id.long(db).name(),
            DocumentableItemId::Member(id) => id.name(db),
            DocumentableItemId::Variant(id) => id.name(db),
        }
    }
}

impl<'db> From<CrateId<'db>> for DocumentableItemId<'db> {
    fn from(value: CrateId<'db>) -> Self {
        DocumentableItemId::Crate(value)
    }
}

impl<'db> From<LookupItemId<'db>> for DocumentableItemId<'db> {
    fn from(value: LookupItemId<'db>) -> Self {
        DocumentableItemId::LookupItem(value)
    }
}

impl<'db> From<MemberId<'db>> for DocumentableItemId<'db> {
    fn from(value: MemberId<'db>) -> Self {
        DocumentableItemId::Member(value)
    }
}
impl<'db> From<VariantId<'db>> for DocumentableItemId<'db> {
    fn from(value: VariantId<'db>) -> Self {
        DocumentableItemId::Variant(value)
    }
}