Struct FileExtractionParameter 

pub struct FileExtractionParameter {
    pub environment_variable: String,
    pub name: String,
    pub description: Option<String>,
    pub required: Option<bool>,
}

Defines an input parameter to be provided to the extractor.

Fields

environment_variable: String

The environment variable that stores the argument.

name: String

Name of the parameter which users will be prompted with.

description: Option<String>

Description of the parameter which users will be prompted with.

required: Option<bool>

Whether the parameter is required for the extractor to run.

Implementations

impl FileExtractionParameter

pub fn description(&self) -> &str

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

pub fn required(&self) -> bool

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

Trait Implementations

impl Clone for FileExtractionParameter

fn clone(&self) -> FileExtractionParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FileExtractionParameter

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

Formats the value using the given formatter.

impl Default for FileExtractionParameter

fn default() -> Self

Returns the “default value” for a type.

impl Message for FileExtractionParameter

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 FileExtractionParameter

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