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

leo_ast/functions/
input.rs
