leo_ast/functions/
annotation.rs

1// Copyright (C) 2019-2025 Provable Inc.
2// This file is part of the Leo library.
3
4// The Leo library is free software: you can redistribute it and/or modify
5// it under the terms of the GNU General Public License as published by
6// the Free Software Foundation, either version 3 of the License, or
7// (at your option) any later version.
8
9// The Leo library is distributed in the hope that it will be useful,
10// but WITHOUT ANY WARRANTY; without even the implied warranty of
11// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12// GNU General Public License for more details.
13
14// You should have received a copy of the GNU General Public License
15// along with the Leo library. If not, see <https://www.gnu.org/licenses/>.
16
17use crate::{Identifier, Node, NodeID, simple_node_impl};
18
19use leo_span::{Span, Symbol};
20
21use indexmap::IndexMap;
22use serde::{Deserialize, Serialize};
23use std::fmt;
24
25/// An annotation, e.g. @program.
26#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq)]
27pub struct Annotation {
28    // TODO: Consider using a symbol instead of an identifier.
29    /// The name of the annotation.
30    pub identifier: Identifier,
31    /// Keys and value associated with the annotation.
32    pub map: IndexMap<Symbol, String>,
33    /// A span locating where the annotation occurred in the source.
34    pub span: Span,
35    /// The ID of the node.
36    pub id: NodeID,
37}
38
39simple_node_impl!(Annotation);
40
41impl fmt::Display for Annotation {
42    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
43        write!(f, "@{}", self.identifier)
44    }
45}
leo_ast/functions/annotation.rs

leo_ast/functions/
annotation.rs
