rune/ast/
item_mod.rs

Help
1use crate::ast::prelude::*;
2
3#[test]
4#[cfg(not(miri))]
5fn ast_parse() {
6    rt::<ast::ItemMod>("mod ruins {}");
7
8    let item = rt::<ast::ItemMod>("#[cfg(test)] mod tests {}");
9    assert_eq!(item.attributes.len(), 1);
10
11    let item = rt::<ast::ItemMod>("mod whiskey_bravo { #![allow(dead_code)] fn x() {} }");
12    assert_eq!(item.attributes.len(), 0);
13    assert!(matches!(item.body, ast::ItemModBody::InlineBody(..)));
14}
15
16/// A module item.
17#[derive(Debug, TryClone, PartialEq, Eq, Parse, ToTokens, Spanned)]
18#[rune(parse = "meta_only")]
19#[non_exhaustive]
20pub struct ItemMod {
21    /// The *inner* attributes are applied to the module  `#[cfg(test)] mod tests {  }`
22    #[rune(iter, meta)]
23    pub attributes: Vec<ast::Attribute>,
24    /// The visibility of the `mod` item
25    #[rune(option, meta)]
26    pub visibility: ast::Visibility,
27    /// The `mod` keyword.
28    pub mod_token: T![mod],
29    /// The name of the mod.
30    pub name: ast::Ident,
31    /// The optional body of the module declaration.
32    pub body: ItemModBody,
33    /// The id of the module item.
34    #[rune(skip)]
35    pub(crate) id: ItemId,
36}
37
38impl ItemMod {
39    /// Get the span of the mod name.
40    pub(crate) fn name_span(&self) -> Span {
41        if let Some(span) = self.visibility.option_span() {
42            span.join(self.name.span())
43        } else {
44            self.mod_token.span().join(self.name.span())
45        }
46    }
47}
48
49item_parse!(Mod, ItemMod, "mod item");
50
51/// An item body.
52#[derive(Debug, TryClone, PartialEq, Eq, ToTokens, Spanned)]
53#[non_exhaustive]
54pub enum ItemModBody {
55    /// An empty body terminated by a semicolon.
56    EmptyBody(T![;]),
57    /// An inline body.
58    InlineBody(ItemInlineBody),
59}
60
61impl Parse for ItemModBody {
62    fn parse(p: &mut Parser<'_>) -> Result<Self> {
63        Ok(match p.nth(0)? {
64            K!['{'] => Self::InlineBody(p.parse()?),
65            _ => Self::EmptyBody(p.parse()?),
66        })
67    }
68}
69
70/// A module declaration.
71#[derive(Debug, TryClone, PartialEq, Eq, ToTokens, Parse, Spanned)]
72#[non_exhaustive]
73pub struct ItemInlineBody {
74    /// The open brace.
75    pub open: T!['{'],
76    /// A nested "file" declaration.
77    #[rune(option)]
78    pub file: Box<ast::File>,
79    /// The close brace.
80    pub close: T!['}'],
81}
82
83impl Peek for ItemInlineBody {
84    fn peek(p: &mut Peeker<'_>) -> bool {
85        <T!['{']>::peek(p)
86    }
87}
rune/ast/item_mod.rs

rune/ast/
item_mod.rs
