leo_ast/statement/
return_.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::{Expression, Node, NodeID, Statement};
18
19use leo_span::Span;
20
21use serde::{Deserialize, Serialize};
22use std::fmt;
23
24/// A return statement `return expression;`.
25#[derive(Clone, PartialEq, Eq, Serialize, Deserialize, Debug)]
26pub struct ReturnStatement {
27    /// The expression to return to the function caller.
28    pub expression: Expression,
29    /// The span of `return expression` excluding the semicolon.
30    pub span: Span,
31    /// The ID of the node.
32    pub id: NodeID,
33}
34
35impl fmt::Display for ReturnStatement {
36    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
37        if let Expression::Unit(..) = self.expression {
38            write!(f, "return")
39        } else {
40            write!(f, "return {}", self.expression)
41        }
42    }
43}
44
45impl From<ReturnStatement> for Statement {
46    fn from(value: ReturnStatement) -> Self {
47        Statement::Return(value)
48    }
49}
50
51crate::simple_node_impl!(ReturnStatement);
leo_ast/statement/return_.rs

leo_ast/statement/
return_.rs
