Struct FlowVariable 

pub struct FlowVariable {
    pub description: Option<String>,
    pub default_value: Option<Value>,
    pub required: bool,
    pub schema: Option<Struct>,
    pub env_var: Option<String>,
}

Definition of a single flow variable.

Fields

description: Option<String>

Human-readable description.

default_value: Option<Value>

Default value for the variable.

required: bool

Whether the variable is required.

schema: Option<Struct>

JSON Schema for this variable’s expected value.

env_var: Option<String>

Environment variable name that populates this variable.

Implementations

impl FlowVariable

pub fn description(&self) -> &str

Returns the value of description, or the default value if description is unset.

pub fn env_var(&self) -> &str

Returns the value of env_var, or the default value if env_var is unset.

Trait Implementations

impl Clone for FlowVariable

fn clone(&self) -> FlowVariable

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FlowVariable

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

Formats the value using the given formatter.

impl Default for FlowVariable

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FlowVariable

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for FlowVariable

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 FlowVariable

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for FlowVariable

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FlowVariable