Struct Argument

pub struct Argument {
    pub name: String,
    pub description: String,
    pub default_value: Option<String>,
    pub required: bool,
    pub short: Option<String>,
    pub long: Option<String>,
}

Arguments for a plugin or a plugins subcommands.

Fields

name: String

Argument name.

description: String

Argument description.

default_value: Option<String>

Optional argument default value.

required: bool

Whether or not this argument is required.

short: Option<String>

Sets the short version of the argument without the preceding -.

long: Option<String>

Sets the long version of the argument without the preceding –.

Implementations

impl Argument

pub fn default_value(&self) -> &str

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

pub fn short(&self) -> &str

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

pub fn long(&self) -> &str

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

Trait Implementations

impl Clone for Argument

fn clone(&self) -> Argument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Argument

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

Formats the value using the given formatter.

impl Default for Argument

fn default() -> Self

Returns the “default value” for a type.

impl Message for Argument

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 Argument

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