Skip to main content

leo_ast/statement/
const_.rs

1// Copyright (C) 2019-2026 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::{Expression, Identifier, Node, NodeID, Statement, TypeNode};
18use leo_span::Span;
19
20use serde::Serialize;
21use std::fmt;
22
23/// A constant declaration statement.
24#[derive(Clone, Default, PartialEq, Eq, Hash, Serialize, Debug)]
25pub struct ConstDeclaration {
26    /// Whether the `export` keyword was written on this const. `None` when
27    /// visibility doesn't apply (statement-level consts).
28    pub is_exported: Option<bool>,
29    /// The place to assign to. As opposed to `DefinitionStatement`, this can only be an identifier
30    pub place: Identifier,
31    /// The type of the binding, if specified, or inferred otherwise.
32    pub type_: TypeNode,
33    /// An initializer value for the binding.
34    pub value: Expression,
35    /// The span excluding the semicolon.
36    pub span: Span,
37    /// The ID of the node.
38    pub id: NodeID,
39}
40
41impl fmt::Display for ConstDeclaration {
42    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
43        if self.is_exported == Some(true) {
44            write!(f, "export ")?;
45        }
46        write!(f, "const {}: {} = {}", self.place, self.type_, self.value)
47    }
48}
49
50impl From<ConstDeclaration> for Statement {
51    fn from(value: ConstDeclaration) -> Self {
52        Statement::Const(value)
53    }
54}
55
56crate::simple_node_impl!(ConstDeclaration);