Struct FileExtractionParameter 

pub struct FileExtractionParameter { /* private fields */ }

Defines an input parameter to be provided to the extractor.

Implementations

impl FileExtractionParameter

pub fn builder() -> Builder<EnvironmentVariableStage>

Returns a new builder.

impl FileExtractionParameter

pub fn new( environment_variable: EnvironmentVariable, name: impl Into<String>, ) -> Self

Constructs a new instance of the type.

pub fn environment_variable(&self) -> &EnvironmentVariable

The environment variable that stores the argument

pub fn name(&self) -> &str

Name of the parameter which users will be prompted with

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

Description of the parameter which users will be prompted with

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

Whether the parameter is required for the extractor to run.

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<'de> Deserialize<'de> for FileExtractionParameter

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FileExtractionParameter> for Builder<Complete>

fn from(v: FileExtractionParameter) -> Self

Converts to this type from the input type.

impl Hash for FileExtractionParameter

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for FileExtractionParameter

fn cmp(&self, other: &FileExtractionParameter) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

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 PartialOrd for FileExtractionParameter

fn partial_cmp(&self, other: &FileExtractionParameter) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for FileExtractionParameter

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for FileExtractionParameter

impl StructuralPartialEq for FileExtractionParameter