Skip to main content

OptionSpec

Enum OptionSpec 

Source
pub enum OptionSpec {
    Toggle {
        id: &'static str,
        label: &'static str,
        default: bool,
    },
    Choice {
        id: &'static str,
        label: &'static str,
        choices: &'static [(&'static str, &'static str)],
        default: &'static str,
    },
    Number {
        id: &'static str,
        label: &'static str,
        min: i64,
        max: i64,
        default: i64,
    },
    Group {
        label: &'static str,
        pane: OptionPane,
    },
    Text {
        id: &'static str,
        label: &'static str,
        placeholder: &'static str,
        default: &'static str,
    },
}

Variants§

§

Toggle

Fields

§id: &'static str
§label: &'static str
§default: bool
§

Choice

A one-of-N picker. Choices are (value, label) pairs.

Fields

§id: &'static str
§label: &'static str
§choices: &'static [(&'static str, &'static str)]
§default: &'static str
§

Number

Fields

§id: &'static str
§label: &'static str
§min: i64
§max: i64
§default: i64
§

Group

Marks where the options that follow belong. Carries no value of its own; it exists so a tool with many knobs can say which of them decide the answer and which decide how it is presented.

Options declared before any group default to OptionPane::Input.

Fields

§label: &'static str
§

Text

A short free-text field, for values no picker can enumerate — a cron field, a delimiter, a format string. Rendered inline with the other options, so keep it genuinely short.

Fields

§id: &'static str
§label: &'static str
§placeholder: &'static str
§default: &'static str

Implementations§

Source§

impl OptionSpec

Source

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

Source

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

Source

pub fn is_value(&self) -> bool

Whether this spec carries a value the user can set.

Trait Implementations§

Source§

impl Clone for OptionSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for OptionSpec

Source§

impl Debug for OptionSpec

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.