Struct rune::ast::ItemFn

pub struct ItemFn {
    pub id: Option<Id>,
    pub attributes: Vec<Attribute>,
    pub visibility: Visibility,
    pub const_token: Option<Const>,
    pub async_token: Option<Async>,
    pub fn_token: Fn,
    pub name: Ident,
    pub args: Parenthesized<FnArg, Comma>,
    pub body: Block,
}

A function item.

Examples

use rune::{testing, ast, parse_all};

testing::roundtrip::<ast::ItemFn>("async fn hello() {}");
assert!(parse_all::<ast::ItemFn>("fn async hello() {}").is_err());

let item = testing::roundtrip::<ast::ItemFn>("fn hello() {}");
assert_eq!(item.args.len(), 0);

let item = testing::roundtrip::<ast::ItemFn>("fn hello(foo, bar) {}");
assert_eq!(item.args.len(), 2);

testing::roundtrip::<ast::ItemFn>("pub fn hello(foo, bar) {}");
testing::roundtrip::<ast::ItemFn>("pub async fn hello(foo, bar) {}");
testing::roundtrip::<ast::ItemFn>("#[inline] fn hello(foo, bar) {}");

let item = testing::roundtrip::<ast::ItemFn>("#[inline] pub async fn hello(foo, bar) {}");
assert!(matches!(item.visibility, ast::Visibility::Public(..)));

assert_eq!(item.args.len(), 2);
assert_eq!(item.attributes.len(), 1);
assert!(item.async_token.is_some());
assert!(item.const_token.is_none());

let item = testing::roundtrip::<ast::ItemFn>("#[inline] pub const fn hello(foo, bar) {}");
assert!(matches!(item.visibility, ast::Visibility::Public(..)));

assert_eq!(item.args.len(), 2);
assert_eq!(item.attributes.len(), 1);
assert!(item.async_token.is_none());
assert!(item.const_token.is_some());

Fields

id: Option<Id>

Opaque identifier for fn item.

attributes: Vec<Attribute>

The attributes for the fn

visibility: Visibility

The visibility of the fn item

const_token: Option<Const>

The optional const keyword.

async_token: Option<Async>

The optional async keyword.

fn_token: Fn

The fn token.

name: Ident

The name of the function.

args: Parenthesized<FnArg, Comma>

The arguments of the function.

body: Block

The body of the function.

Implementations

impl ItemFn

pub fn parse_with_meta(
    parser: &mut Parser<'_>,
    attributes: Vec<Attribute>,
    visibility: Visibility,
    const_token: Option<Const>,
    async_token: Option<Async>
) -> Result<Self, ParseError>

Parse #ident and attach the given meta

impl ItemFn

pub fn descriptive_span(&self) -> Span

Get the descriptive span of this item, e.g. pub fn foo() instead of the span for the whole function declaration, body included.

pub fn is_instance(&self) -> bool

Test if function is an instance fn.

Trait Implementations

impl Clone for ItemFn

fn clone(&self) -> ItemFn

Returns a copy of the value.

pub fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ItemFn

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for ItemFn

impl Parse for ItemFn

fn parse(p: &mut Parser<'_>) -> Result<Self, ParseError>

Parse the current item from the parser.

impl PartialEq<ItemFn> for ItemFn

fn eq(&self, other: &ItemFn) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ItemFn) -> bool

This method tests for !=.

impl Peek for ItemFn

fn peek(p: &mut Peeker<'_>) -> bool

Peek the parser for the given token.

impl Spanned for ItemFn

fn span(&self) -> Span

Get the span of the type.

impl StructuralEq for ItemFn

impl StructuralPartialEq for ItemFn

impl ToTokens for ItemFn

fn to_tokens(&self, context: &MacroContext, stream: &mut TokenStream)

Turn the current item into tokens.