Struct FunctionManifest 

#[repr(C)]
pub struct FunctionManifest {
    pub name: RString,
    pub version: RString,
    pub description: RString,
    pub visibility: Visibility,
    pub role: RString,
    pub method: HttpMethod,
    pub permission: RString,
    pub admin: RString,
    pub config_schema: RString,
    pub input_schema: RString,
    pub output_schema: RString,
}

Static description of a function, read once at load time.

Fields

name: RString

URL-safe identifier, e.g. "greet" → mounted at /functions/greet.

version: RString

Semver of the function itself (independent of the ABI version).

description: RString

Human description, surfaced in generated API docs.

visibility: Visibility

Access-control policy for the generated endpoint.

role: RString

Required role name when visibility == RoleGated, else empty.

method: HttpMethod

HTTP method the endpoint answers.

permission: RString

Access policy in the same string grammar a resource’s [permissions] uses — "public", "authenticated", "member", "role:admin", "private"/"none". Empty means “derive it from visibility and role”, which is what a function that predates this field gets.

This exists because Visibility cannot express member — “anyone in the active organisation” — which is the level most operator-facing actions actually want, and because sharing one grammar with resources means an app has exactly one thing to learn about access.

admin: RString

Dashboard presentation as a JSON object, or empty for the defaults:

{ "visible": true, "roles": ["admin"], "label": "Reindex catalogue",
  "group": "Maintenance", "confirm": "Reindex every product?",
  "run_label": "Reindex", "order": 10 }

Carried as JSON rather than as struct fields so that adding a presentation knob later never changes this struct’s layout — and so never invalidates an already-compiled function library.

config_schema: RString

Optional JSON-Schema describing the function’s config object. Empty = none.

input_schema: RString

Optional JSON-Schema for the request body. Empty = untyped. Surfaced in the generated OpenAPI document so function I/O is typed in the docs.

output_schema: RString

Optional JSON-Schema for the response body. Empty = untyped.

Implementations

impl FunctionManifest

pub fn access(&self) -> FunctionAccess

The policy the host enforces for this function.

An explicit, parseable permission wins. Otherwise the legacy visibility + role pair is used, so libraries compiled before permission existed keep exactly the access they always had. An unparseable permission collapses to FunctionAccess::Private — the safe direction, matching how the rest of apiplant treats a typo in an access string.

Trait Implementations

impl Clone for FunctionManifest

fn clone(&self) -> FunctionManifest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionManifest

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

Formats the value using the given formatter.

impl GetStaticEquivalent_ for FunctionManifest

type StaticEquivalent = _static_FunctionManifest

The 'static equivalent of Self

impl StableAbi for FunctionManifest

const LAYOUT: &'static TypeLayout

The layout of the type provided by implementors.

type IsNonZeroType = False

Whether this type has a single invalid bit-pattern.

const ABI_CONSTS: AbiConsts = _

const-equivalents of the associated types.