Struct Function

pub struct Function {
    pub name: String,
    pub path: String,
    pub description: String,
    pub deprecation_note: Option<String>,
    pub input_type: Option<TypeReference>,
    pub input_headers: Option<TypeReference>,
    pub output_type: Option<TypeReference>,
    pub error_type: Option<TypeReference>,
    pub serialization: Vec<SerializationMode>,
    pub readonly: bool,
    pub tags: BTreeSet<String>,
}

Fields

name: String

Includes entity and action, for example: users.login

path: String

URL mounting path, for example: /api/v1

description: String

Description of the call

deprecation_note: Option<String>

Deprecation note. If none, function is not deprecated. If present as empty string, function is deprecated without a note.

input_type: Option<TypeReference>

input_headers: Option<TypeReference>

output_type: Option<TypeReference>

error_type: Option<TypeReference>

serialization: Vec<SerializationMode>

Supported content types for request and response bodies.

Note: serialization for header values is not affected by this field. For displayable types of fields, it is encoded in plain strings. For non-displayable types, it is encoded as json.

Default: only json if empty

readonly: bool

If a function is readonly, it means it does not modify the state of an application

tags: BTreeSet<String>

Implementations

impl Function

pub fn new(name: String) -> Self

pub fn name(&self) -> &str

pub fn path(&self) -> &str

pub fn description(&self) -> &str

pub fn deprecated(&self) -> bool

pub fn input_type(&self) -> Option<&TypeReference>

pub fn input_headers(&self) -> Option<&TypeReference>

pub fn output_type(&self) -> Option<&TypeReference>

pub fn error_type(&self) -> Option<&TypeReference>

pub fn serialization(&self) -> Iter<'_, SerializationMode>

pub fn readonly(&self) -> bool

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Function

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Function

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Function

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

where __S: Serializer,

Serialize this value into the given Serde serializer.