leo_ast/functions/
mode.rs

1// Copyright (C) 2019-2026 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 core::fmt;
18use serde::{Deserialize, Serialize};
19
20/// The mode associated with a type.
21#[derive(Debug, Clone, Copy, PartialEq, Eq, Serialize, Deserialize)]
22pub enum Mode {
23    None,
24    Constant,
25    Private,
26    Public,
27}
28
29impl Mode {
30    /// Are the modes considered equal as far as the Leo user is concerned?
31    ///
32    /// In particular, `None` defaults to `Private`.
33    pub fn eq_user(&self, other: &Mode) -> bool {
34        match (self, other) {
35            (Self::None | Self::Private, Self::None | Self::Private) => true,
36            (a, b) => a == b,
37        }
38    }
39}
40
41impl fmt::Display for Mode {
42    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
43        use Mode::*;
44
45        match self {
46            None => write!(f, ""),
47            Constant => write!(f, "constant"),
48            Private => write!(f, "private"),
49            Public => write!(f, "public"),
50        }
51    }
52}
leo_ast/functions/mode.rs

leo_ast/functions/
mode.rs
