Struct FunctionSpec 

#[non_exhaustive]
pub struct FunctionSpec {
    pub description: Cow<'static, str>,
    pub category: Cow<'static, str>,
    pub retry: RetrySafety,
    pub references: Vec<Reference>,
    pub runtime_fields: Option<Vec<FieldSpec>>,
}

What a function says about itself, for tooling. Data only.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

description: Cow<'static, str>

What the function does.

category: Cow<'static, str>

The group it is listed under.

retry: RetrySafety

Whether a retry is safe.

references: Vec<Reference>

The config fields that name other definitions.

runtime_fields: Option<Vec<FieldSpec>>

The config’s fields, when a plugin declares them at runtime.

Implementations

impl FunctionSpec

pub fn with_description(self, description: impl Into<Cow<'static, str>>) -> Self

Sets the description.

pub fn with_category(self, category: impl Into<Cow<'static, str>>) -> Self

Sets the category.

pub fn with_retry(self, retry: RetrySafety) -> Self

Sets the retry safety.

pub fn with_references(self, references: Vec<Reference>) -> Self

Sets the references.

pub fn with_runtime_fields(self, fields: Vec<FieldSpec>) -> Self

Sets the runtime-declared fields.

Trait Implementations

impl Clone for FunctionSpec

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FunctionSpec

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

Formats the value using the given formatter.

impl Default for FunctionSpec

fn default() -> Self

Returns the “default value” for a type.