Struct CustomParameter

#[non_exhaustive]
pub struct CustomParameter {
    pub key_name: String,
    pub description: Option<String>,
    pub field_type: String,
    pub default_value: Option<String>,
    pub is_editable: Option<bool>,
    pub is_optional: Option<bool>,
}

The details of user parameters of an environment blueprint.

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.

key_name: String

The key name of the parameter.

description: Option<String>

The description of the parameter.

field_type: String

The filed type of the parameter.

default_value: Option<String>

The default value of the parameter.

is_editable: Option<bool>

Specifies whether the parameter is editable.

is_optional: Option<bool>

Specifies whether the custom parameter is optional.

Implementations

impl CustomParameter

pub fn key_name(&self) -> &str

The key name of the parameter.

pub fn description(&self) -> Option<&str>

The description of the parameter.

pub fn field_type(&self) -> &str

The filed type of the parameter.

pub fn default_value(&self) -> Option<&str>

The default value of the parameter.

pub fn is_editable(&self) -> Option<bool>

Specifies whether the parameter is editable.

pub fn is_optional(&self) -> Option<bool>

Specifies whether the custom parameter is optional.

impl CustomParameter

pub fn builder() -> CustomParameterBuilder

Creates a new builder-style object to manufacture CustomParameter.

Trait Implementations

impl Clone for CustomParameter

fn clone(&self) -> CustomParameter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CustomParameter

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

Formats the value using the given formatter.

impl PartialEq for CustomParameter

fn eq(&self, other: &CustomParameter) -> 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 StructuralPartialEq for CustomParameter