leo_ast/expressions/
tuple_access.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, NonNegativeNumber};
18use leo_span::Span;
19
20use serde::{Deserialize, Serialize};
21use std::fmt;
22
23/// A tuple access expression, e.g., `tuple.index`.
24#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
25pub struct TupleAccess {
26    /// An expression evaluating to some tuple type, e.g., `(5, 2)`.
27    pub tuple: Expression,
28    /// The index to access in the tuple expression. E.g., `0` for `(5, 2)` would yield `5`.
29    pub index: NonNegativeNumber,
30    /// The span for the entire expression `tuple.index`.
31    pub span: Span,
32    /// The ID of the node.
33    pub id: NodeID,
34}
35
36impl fmt::Display for TupleAccess {
37    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
38        write!(f, "{}.{}", self.tuple, self.index)
39    }
40}
41
42impl From<TupleAccess> for Expression {
43    fn from(value: TupleAccess) -> Self {
44        Expression::TupleAccess(Box::new(value))
45    }
46}
47
48crate::simple_node_impl!(TupleAccess);