Struct FunctionConfig 

pub struct FunctionConfig {

    pub ffi: Option<FunctionFfi>,
    pub ref: Option<String>,
    pub name: Option<String>,
    pub readonly: Option<bool>,
    pub bindgen: Option<Bindgen>,
    pub toolchain: Option<FunctionToolchain>,
    pub build: Option<Vec<Vec<String>>>,
    pub bin: Option<String>,
    pub protected: Option<bool>,
    pub access: Option<Vec<FunctionAccessPermission>>,
    pub input: Option<Kind>,
    pub output: Option<Kind>,
    pub cache: Option<StoredCache>,
    pub variables: Option<Vec<String>>,
    pub timeout: Option<u16>,
}

Configuration parameters for Ordinary Functions.

Fields

ffi: Option<FunctionFfi>

Foreign function interface config

ref: Option<String>

Refers to the template config in another location

name: Option<String>

Function name. Must be unique.

readonly: Option<bool>

bindgen: Option<Bindgen>

which language the input binding WebAssembly Component should be compiled from.

Note: because the bindings are compiled to a WebAssembly Component, with a companion WIT file, the resulting bindings can be used by any language that has WIT support.

i.e. bindings compiled from Rust can be plugged into a Golang WebAssembly component.

Important: if your FFI serialization format is JSON, or you are comfortable writing your own FlexBuffer vector accessors it is not necessary to generate the bindings (other than for reference in the FlexBuffer vector accessing case).

toolchain: Option<FunctionToolchain>

language for which the function builds

build: Option<Vec<Vec<String>>>

build scripts for ensuring the WebAssembly components are composed properly at build time.

bin: Option<String>

path to the WASM component binary

protected: Option<bool>

What to check the token fields against. If unset function is public.

access: Option<Vec<FunctionAccessPermission>>

Which Ordinary Application resources and host extensions this function has access to.

input: Option<Kind>

Input definition for the action.

output: Option<Kind>

Output definition for the action.

cache: Option<StoredCache>

Persistent result cache configuration for readonly functions.

variables: Option<Vec<String>>

List of build time environment variables.

format in template: {{ YOUR_VAR }}

timeout: Option<u16>

Max duration for the action.

Unit: seconds

Implementations

impl FunctionConfig

pub fn load_bindgen(&mut self)

pub fn ffi_validated(&self) -> &FunctionFfi

Panics

This method panics if the ffi field has not been validated to be present

pub fn name_validated(&self) -> &str

Panics

This method panics if the name field has not been validated to be present

pub fn input_validated(&self) -> &Kind

Panics

This method panics if the accepts field has not been validated to be present

pub fn output_validated(&self) -> &Kind

Panics

This method panics if the returns field has not been validated to be present

Trait Implementations

impl Clone for FunctionConfig

fn clone(&self) -> FunctionConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ComposeSchema for FunctionConfig

Available on crate feature utoipa only.

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl Debug for FunctionConfig

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

Formats the value using the given formatter.

impl Default for FunctionConfig

fn default() -> FunctionConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FunctionConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for FunctionConfig

Available on crate feature docs only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for FunctionConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl ToSchema for FunctionConfig

Available on crate feature utoipa only.

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.