leo_ast/functions/
output.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::{Mode, Node, NodeID, Type};
18use leo_span::Span;
19
20use serde::{Deserialize, Serialize};
21use std::fmt;
22
23/// A function output.
24#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
25pub struct Output {
26    /// The mode of the function output.
27    pub mode: Mode,
28    /// The type of the function output.
29    pub type_: Type,
30    /// The parameters span from any annotations to its type.
31    pub span: Span,
32    /// The ID of the node.
33    pub id: NodeID,
34}
35
36impl Output {
37    pub fn type_(&self) -> &Type {
38        &self.type_
39    }
40
41    pub fn mode(&self) -> Mode {
42        self.mode
43    }
44}
45
46impl fmt::Display for Output {
47    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
48        if self.mode == Mode::None { write!(f, "{}", self.type_) } else { write!(f, "{} {}", self.mode, self.type_) }
49    }
50}
51
52crate::simple_node_impl!(Output);
leo_ast/functions/output.rs

leo_ast/functions/
output.rs
