Enum ImporterParameter 

pub enum ImporterParameter {
    Flag {
        name: &'static str,
        short_name: &'static str,
        explanation: &'static str,
    },
    String {
        name: &'static str,
        short_name: &'static str,
        explanation: &'static str,
        allowed_values: Option<&'static [&'static str]>,
        default_value: &'static str,
    },
    Usize {
        name: &'static str,
        short_name: &'static str,
        explanation: &'static str,
        minimum_value: Option<usize>,
        maximum_value: Option<usize>,
        default_value: usize,
    },
    Fraction {
        name: &'static str,
        short_name: &'static str,
        explanation: &'static str,
        minimum_value: Option<ConstFraction>,
        maximum_value: Option<ConstFraction>,
        default_value: ConstFraction,
    },
}

Parameters that can be given to an importer. It is a design decision that every parameter must have a default, to ensure every importer (also) works without user interaction.

Variants

Flag

Fields

name: &'static str

short_name: &'static str

explanation: &'static str

String

Fields

name: &'static str

short_name: &'static str

explanation: &'static str

allowed_values: Option<&'static [&'static str]>

default_value: &'static str

Usize

Fields

name: &'static str

short_name: &'static str

explanation: &'static str

minimum_value: Option<usize>

maximum_value: Option<usize>

default_value: usize

Fraction

Fields

name: &'static str

short_name: &'static str

explanation: &'static str

minimum_value: Option<ConstFraction>

maximum_value: Option<ConstFraction>

default_value: ConstFraction

Implementations

impl ImporterParameter

pub fn name(&self) -> &'static str

pub fn short_name(&self) -> &'static str

pub fn explanation(&self) -> &'static str

pub fn default(&self) -> ImporterParameterValue

Trait Implementations

impl Clone for ImporterParameter

fn clone(&self) -> ImporterParameter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImporterParameter

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

Formats the value using the given formatter.

impl Display for ImporterParameter

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

Formats the value using the given formatter.

impl Hash for ImporterParameter

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 ImporterParameter

fn cmp(&self, other: &Self) -> 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 ImporterParameter

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

fn partial_cmp(&self, other: &Self) -> 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 Copy for ImporterParameter

impl Eq for ImporterParameter