reorganize module

This commit is contained in:
Timur Gordon
2025-04-04 08:28:07 +02:00
parent 1ea37e2e7f
commit 939b6b4e57
375 changed files with 7580 additions and 191 deletions

View File

@@ -0,0 +1,20 @@
Get Scripted Functions Metadata from AST
=========================================
{{#include ../links.md}}
Use [`AST::iter_functions`](https://docs.rs/rhai/latest/rhai/struct.AST.html#method.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)<br/>`FnAccess::Private` ([`private`]) |
| `comments` | [`metadata`] | `Vec<&str>` | [Doc-comments], if any, one per line |