Functions Metadata
The metadata of a function means all relevant information related to a function’s definition including:
-
Its callable name
-
Its access mode (public or private)
-
Its parameter names and types (if any)
-
Its return value and type (if any)
-
Its nature (i.e. native Rust or Rhai-scripted)
-
Its purpose, in the form of doc-comments
-
Usage notes, warnings, examples etc., in the form of doc-comments
A function’s signature encapsulates the first four pieces of information in a single concise line of definition:
[private]
name(
param 1:
type 1,
param 2:
type 2,
…,
param n:
type n) ->
return type
Exporting metadata requires the [`metadata`] feature.