Struct CommandParameterBuilder

#[non_exhaustive]
pub struct CommandParameterBuilder { /* private fields */ }

A builder for CommandParameter.

Implementations

impl CommandParameterBuilder

pub fn name(self, input: impl Into<String>) -> Self

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

This field is required.

pub fn set_name(self, input: Option<String>) -> Self

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

pub fn get_name(&self) -> &Option<String>

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

pub fn value(self, input: CommandParameterValue) -> Self

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 set_value(self, input: Option<CommandParameterValue>) -> Self

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 get_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, input: CommandParameterValue) -> Self

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 set_default_value(self, input: Option<CommandParameterValue>) -> Self

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 get_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, input: impl Into<String>) -> Self

The description of the command parameter.

pub fn set_description(self, input: Option<String>) -> Self

The description of the command parameter.

pub fn get_description(&self) -> &Option<String>

The description of the command parameter.

pub fn build(self) -> Result<CommandParameter, BuildError>

Consumes the builder and constructs a CommandParameter. This method will fail if any of the following fields are not set:

• name

Trait Implementations

impl Clone for CommandParameterBuilder

fn clone(&self) -> CommandParameterBuilder

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CommandParameterBuilder

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

Formats the value using the given formatter.

impl Default for CommandParameterBuilder

fn default() -> CommandParameterBuilder

Returns the “default value” for a type.

impl PartialEq for CommandParameterBuilder

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

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

const 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 CommandParameterBuilder