This repository has been archived on 2025-08-04. You can view files and clone it, but cannot push or open issues or pull requests.
rhaj/_archive/rhai_engine/rhaibook/rust/functions-metadata.md
2025-04-04 08:28:07 +02:00

1.1 KiB

Get Scripted Functions Metadata from AST

{{#include ../links.md}}

Use AST::iter_functions to iterate through all the script-defined [functions] in an [AST].

ScriptFnMetadata

The type returned from the iterator is ScriptFnMetadata with the following fields:

Field Requires Type Description
name &str Name of [function]
params Vec<&str> Number of parameters
access FnAccess FnAccess::Public (public)
FnAccess::Private ([private])
comments [metadata] Vec<&str> [Doc-comments], if any, one per line