leo_ast/functions/
const_parameter.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, Type};
18use leo_span::Span;
19
20use serde::{Deserialize, Serialize};
21use std::fmt;
22
23/// A function const parameter.
24#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
25pub struct ConstParameter {
26    /// The name the const parameter is accessible as in the function's body.
27    pub identifier: Identifier,
28    /// What's the const parameter's type?
29    pub type_: Type,
30    /// The const parameter's span from any annotations to its type.
31    pub span: Span,
32    /// The ID of the node.
33    pub id: NodeID,
34}
35
36impl ConstParameter {
37    fn format(&self, f: &mut fmt::Formatter) -> fmt::Result {
38        write!(f, "{}: {}", self.identifier, self.type_)
39    }
40
41    pub fn identifier(&self) -> &Identifier {
42        &self.identifier
43    }
44
45    pub fn type_(&self) -> &Type {
46        &self.type_
47    }
48}
49
50impl fmt::Display for ConstParameter {
51    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
52        self.format(f)
53    }
54}
55
56crate::simple_node_impl!(ConstParameter);
leo_ast/functions/const_parameter.rs

leo_ast/functions/
const_parameter.rs
