leo_ast/statement/
assert.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 variant of an assert statement.
25#[derive(Clone, PartialEq, Eq, Serialize, Deserialize, Debug)]
26pub enum AssertVariant {
27    /// A `assert(expr)` variant, asserting that the expression evaluates to true.
28    Assert(Expression),
29    /// A `assert_eq(expr1, expr2)` variant, asserting that the operands are equal.
30    AssertEq(Expression, Expression),
31    /// A `assert_neq(expr1, expr2)` variant, asserting that the operands are not equal.
32    AssertNeq(Expression, Expression),
33}
34
35/// An assert statement, `assert(<expr>)`, `assert_eq(<expr>)` or `assert_neq(<expr>)`.
36#[derive(Clone, PartialEq, Eq, Serialize, Deserialize, Debug)]
37pub struct AssertStatement {
38    /// The variant of the assert statement.
39    pub variant: AssertVariant,
40    /// The span, excluding the semicolon.
41    pub span: Span,
42    /// The ID of the node.
43    pub id: NodeID,
44}
45
46impl fmt::Display for AssertStatement {
47    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
48        match self.variant {
49            AssertVariant::Assert(ref expr) => write!(f, "assert({expr})"),
50            AssertVariant::AssertEq(ref expr1, ref expr2) => write!(f, "assert_eq({expr1}, {expr2})"),
51            AssertVariant::AssertNeq(ref expr1, ref expr2) => write!(f, "assert_neq({expr1}, {expr2})"),
52        }
53    }
54}
55
56impl From<AssertStatement> for Statement {
57    fn from(value: AssertStatement) -> Self {
58        Statement::Assert(value)
59    }
60}
61
62crate::simple_node_impl!(AssertStatement);
leo_ast/statement/assert.rs

leo_ast/statement/
assert.rs
