Struct Function 

pub struct Function {
    pub parameters: Vec<Parameter>,
    pub variadic_parameter: Option<Parameter>,
    pub return: Option<Return>,
    pub summary: String,
    pub description: String,
    pub description_kind: i32,
    pub deprecation_message: String,
}

Fields

parameters: Vec<Parameter>

parameters is the ordered list of positional function parameters.

variadic_parameter: Option<Parameter>

variadic_parameter is an optional final parameter which accepts zero or more argument values, in which Terraform will send an ordered list of the parameter type.

return: Option<Return>

Return is the function return parameter.

summary: String

summary is the human-readable shortened documentation for the function.

description: String

description is human-readable documentation for the function.

description_kind: i32

description_kind is the formatting of the description.

deprecation_message: String

deprecation_message is human-readable documentation if the function is deprecated.

Implementations

impl Function

pub fn description_kind(&self) -> StringKind

Returns the enum value of description_kind, or the default if the field is set to an invalid enum value.

pub fn set_description_kind(&mut self, value: StringKind)

Sets description_kind to the provided enum value.

Trait Implementations

impl Clone for Function

fn clone(&self) -> Function

Returns a duplicate 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 Default for Function

fn default() -> Self

Returns the “default value” for a type.

impl Message for Function

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Function

fn eq(&self, other: &Function) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Function