Struct CommandParameter

#[non_exhaustive]
pub struct CommandParameter {
    pub name: String,
    pub value: Option<CommandParameterValue>,
    pub default_value: Option<CommandParameterValue>,
    pub description: Option<String>,
}

A map of key-value pairs that describe the command.

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.

name: String

The name of a specific parameter used in a command and command execution.

value: Option<CommandParameterValue>

The value used to describe the command. When you assign a value to a parameter, it will override any default value that you had already specified.

default_value: Option<CommandParameterValue>

The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.

description: Option<String>

The description of the command parameter.

Implementations

impl CommandParameter

pub fn name(&self) -> &str

The name of a specific parameter used in a command and command execution.

pub fn value(&self) -> Option<&CommandParameterValue>

The value used to describe the command. When you assign a value to a parameter, it will override any default value that you had already specified.

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

The default value used to describe the command. This is the value assumed by the parameter if no other value is assigned to it.

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

The description of the command parameter.

impl CommandParameter

pub fn builder() -> CommandParameterBuilder

Creates a new builder-style object to manufacture CommandParameter.

Trait Implementations

impl Clone for CommandParameter

fn clone(&self) -> CommandParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandParameter

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

Formats the value using the given formatter.

impl PartialEq for CommandParameter

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