leo_ast/mapping/
mod.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, Node, NodeID, Type};
18
19use leo_span::Span;
20
21use serde::{Deserialize, Serialize};
22use snarkvm::prelude::{Mapping as MappingCore, Network};
23use std::fmt;
24
25/// A mapping declaration, e.g `mapping balances: address => u128`.
26#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
27pub struct Mapping {
28    /// The name of the mapping.
29    pub identifier: Identifier,
30    /// The type of the key.
31    pub key_type: Type,
32    /// The type of the value.
33    pub value_type: Type,
34    /// The entire span of the mapping declaration.
35    pub span: Span,
36    /// The ID of the node.
37    pub id: NodeID,
38}
39
40impl Mapping {
41    pub fn from_snarkvm<N: Network>(mapping: &MappingCore<N>) -> Self {
42        Self {
43            identifier: Identifier::from(mapping.name()),
44            key_type: Type::from_snarkvm(mapping.key().plaintext_type(), None),
45            value_type: Type::from_snarkvm(mapping.value().plaintext_type(), None),
46            span: Default::default(),
47            id: Default::default(),
48        }
49    }
50}
51impl fmt::Display for Mapping {
52    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
53        write!(f, "mapping {}: {} => {}", self.identifier, self.key_type, self.value_type)
54    }
55}
56
57crate::simple_node_impl!(Mapping);
leo_ast/mapping/mod.rs

leo_ast/mapping/
mod.rs
