leo_ast/expressions/
locator.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, ProgramId, simple_node_impl};
18
19use leo_span::{Span, Symbol};
20
21use serde::{Deserialize, Serialize};
22use std::{fmt, hash::Hash};
23
24/// A locator that references an external resource.
25#[derive(Clone, Copy, PartialEq, Eq, Hash, Serialize, Deserialize)]
26pub struct LocatorExpression {
27    /// The program that the resource is in.
28    pub program: ProgramId,
29    /// The name of the resource.
30    pub name: Symbol,
31    /// A span indicating where the locator occurred in the source.
32    pub span: Span,
33    /// The ID of the node.
34    pub id: NodeID,
35}
36
37simple_node_impl!(LocatorExpression);
38
39impl LocatorExpression {
40    /// Constructs a new Locator with `name`, `program` and `id` and a default span.
41    pub fn new(program: ProgramId, name: Symbol, id: NodeID) -> Self {
42        Self { program, name, span: Span::default(), id }
43    }
44
45    /// Check if the Locator name and program matches the other name and program.
46    pub fn matches(&self, other: &Self) -> bool {
47        self.name == other.name && self.program == other.program
48    }
49}
50
51impl fmt::Display for LocatorExpression {
52    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
53        write!(f, "{}/{}", self.program, self.name)
54    }
55}
56
57impl fmt::Debug for LocatorExpression {
58    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
59        write!(f, "{}/{}", self.program, self.name)
60    }
61}
62
63impl From<LocatorExpression> for Expression {
64    fn from(value: LocatorExpression) -> Self {
65        Expression::Locator(value)
66    }
67}
leo_ast/expressions/locator.rs

leo_ast/expressions/
locator.rs
