alloy_sol_type_parser/
tuple.rs

Help
1use crate::{
2    new_input,
3    utils::{spanned, tuple_parser},
4    Error, Input, Result, TypeSpecifier,
5};
6use alloc::vec::Vec;
7use winnow::{
8    combinator::{opt, preceded, trace},
9    ModalResult, Parser,
10};
11
12/// A tuple specifier, with no array suffixes. Corresponds to a sequence of
13/// types.
14///
15/// The internal types are all [`TypeSpecifier`], and may be arbitrarily
16/// complex.
17///
18/// # Examples
19///
20/// ```
21/// # use alloy_sol_type_parser::TupleSpecifier;
22/// let spec = TupleSpecifier::parse("(uint256,uint256)")?;
23/// assert_eq!(spec.span(), "(uint256,uint256)");
24/// assert_eq!(spec.types.len(), 2);
25/// assert_eq!(spec.types[0].span(), "uint256");
26///
27/// // No array suffixes. Use `TypeSpecifier` instead.
28/// assert!(TupleSpecifier::parse("(uint256,uint256)[]").is_err());
29/// # Ok::<_, alloy_sol_type_parser::Error>(())
30/// ```
31#[derive(Clone, Debug, PartialEq, Eq)]
32pub struct TupleSpecifier<'a> {
33    /// The full span of the tuple specifier.
34    pub span: &'a str,
35    /// The internal types.
36    pub types: Vec<TypeSpecifier<'a>>,
37}
38
39impl<'a> TryFrom<&'a str> for TupleSpecifier<'a> {
40    type Error = Error;
41
42    #[inline]
43    fn try_from(value: &'a str) -> Result<Self> {
44        Self::parse(value)
45    }
46}
47
48impl AsRef<str> for TupleSpecifier<'_> {
49    #[inline]
50    fn as_ref(&self) -> &str {
51        self.span()
52    }
53}
54
55impl<'a> TupleSpecifier<'a> {
56    /// Parse a tuple specifier from a string.
57    #[inline]
58    pub fn parse(input: &'a str) -> Result<Self> {
59        Self::parser.parse(new_input(input)).map_err(Error::parser)
60    }
61
62    /// [`winnow`] parser for this type.
63    pub(crate) fn parser(input: &mut Input<'a>) -> ModalResult<Self> {
64        trace("TupleSpecifier", spanned(Self::parse_types))
65            .parse_next(input)
66            .map(|(span, types)| Self { span, types })
67    }
68
69    #[inline]
70    fn parse_types(input: &mut Input<'a>) -> ModalResult<Vec<TypeSpecifier<'a>>> {
71        preceded(opt("tuple"), tuple_parser(TypeSpecifier::parser)).parse_next(input)
72    }
73
74    /// Returns the tuple specifier as a string.
75    #[inline]
76    pub const fn span(&self) -> &'a str {
77        self.span
78    }
79
80    /// Returns true if the type is a basic Solidity type.
81    #[inline]
82    pub fn try_basic_solidity(&self) -> Result<()> {
83        self.types.iter().try_for_each(TypeSpecifier::try_basic_solidity)
84    }
85}
86
87#[cfg(test)]
88mod test {
89    use super::*;
90
91    #[test]
92    fn extra_close_parens() {
93        TupleSpecifier::parse("bool,uint256))").unwrap_err();
94    }
95
96    #[test]
97    fn extra_open_parents() {
98        TupleSpecifier::parse("(bool,uint256").unwrap_err();
99    }
100
101    #[test]
102    fn nested_tuples() {
103        assert_eq!(
104            TupleSpecifier::parse("(bool,(uint256,uint256))").unwrap(),
105            TupleSpecifier {
106                span: "(bool,(uint256,uint256))",
107                types: vec![
108                    TypeSpecifier::parse("bool").unwrap(),
109                    TypeSpecifier::parse("(uint256,uint256)").unwrap(),
110                ]
111            }
112        );
113        assert_eq!(
114            TupleSpecifier::parse("(((bool),),)").unwrap(),
115            TupleSpecifier {
116                span: "(((bool),),)",
117                types: vec![TypeSpecifier::parse("((bool),)").unwrap()]
118            }
119        );
120    }
121
122    #[test]
123    fn does_not_parse_missing_parens() {
124        TupleSpecifier::parse("bool,uint256").unwrap_err();
125    }
126
127    #[test]
128    fn stack_overflow() {
129        let s = "((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((((";
130        TupleSpecifier::parse(s).unwrap_err();
131    }
132}
alloy_sol_type_parser/tuple.rs

alloy_sol_type_parser/
tuple.rs
