leo_ast/expressions/
associated_function.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, Identifier, Node, NodeID, Type};
18use leo_span::Span;
19
20use itertools::Itertools as _;
21use serde::{Deserialize, Serialize};
22use std::fmt;
23
24/// An access expression to an associated function in a struct, e.g.`Pedersen64::hash()`.
25#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
26pub struct AssociatedFunctionExpression {
27    /// The inner struct variant.
28    pub variant: Identifier,
29    /// The static struct member function that is being accessed.
30    pub name: Identifier,
31    /// Type parameters for generic associated functions.
32    pub type_parameters: Vec<(Type, Span)>,
33    /// The arguments passed to the function `name`.
34    pub arguments: Vec<Expression>,
35    /// The span for the entire expression `Foo::bar()`.
36    pub span: Span,
37    /// The ID of the node.
38    pub id: NodeID,
39}
40
41impl fmt::Display for AssociatedFunctionExpression {
42    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
43        // Format type parameters if they exist.
44        let type_parameters = if !self.type_parameters.is_empty() {
45            format!("::[{}]", self.type_parameters.iter().map(|(t, _)| t.to_string()).format(", "))
46        } else {
47            String::new()
48        };
49        write!(f, "{}::{}{type_parameters}({})", self.variant, self.name, self.arguments.iter().format(", "))
50    }
51}
52
53impl From<AssociatedFunctionExpression> for Expression {
54    fn from(value: AssociatedFunctionExpression) -> Self {
55        Expression::AssociatedFunction(value)
56    }
57}
58
59crate::simple_node_impl!(AssociatedFunctionExpression);