Enum Option

#[non_exhaustive]
pub enum Option {
    AllExport,
    Clobber,
    CmdLine,
    ErrExit,
    Exec,
    Glob,
    HashOnDefinition,
    IgnoreEof,
    Interactive,
    Log,
    Login,
    Monitor,
    Notify,
    PosixlyCorrect,
    Stdin,
    Unset,
    Verbose,
    Vi,
    XTrace,
}

Shell option

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AllExport

Makes all variables exported when they are assigned.

Clobber

Allows overwriting and truncating an existing file with the > redirection.

CmdLine

Executes a command string specified as a command line argument.

ErrExit

Makes the shell to exit when a command returns a non-zero exit status.

Exec

Makes the shell to actually run commands.

Glob

Enables pathname expansion.

HashOnDefinition

Performs command search for each command in a function on its definition.

IgnoreEof

Prevents the interactive shell from exiting when the user enters an end-of-file.

Interactive

Enables features for interactive use.

Log

Allows function definition commands to be recorded in the command history.

Login

Sources the profile file on startup.

Monitor

Enables job control.

Notify

Automatically reports the results of asynchronous jobs.

PosixlyCorrect

Disables most non-POSIX extensions.

Stdin

Reads commands from the standard input.

Unset

Expands unset variables to an empty string rather than erroring out.

Verbose

Echos the input before parsing and executing.

Vi

Enables vi-like command line editing.

XTrace

Prints expanded words during command execution.

Implementations

impl Option

pub const fn is_modifiable(self) -> bool

Whether this option can be modified by the set built-in.

Unmodifiable options can be set only on shell startup.

pub const fn short_name(self) -> Option<(char, State)>

Returns the single-character option name.

This function returns a short name for the option and the state rendered by the name. The name can be converted back to Option with parse_short. Note that the result is None for options that do not have a short name.

pub const fn long_name(self) -> &'static str

Returns the option name, all in lower case without punctuations.

This function returns a string like "allexport" and "exec". The name can be converted back to Option with parse_long.

impl Option

pub fn iter() -> Iter

Creates an iterator that yields all available options in alphabetical order.

Trait Implementations

impl<O: Into<EnumSet<Option>>> BitAnd<O> for Option

type Output = EnumSet<Option>

The resulting type after applying the & operator.

fn bitand(self, other: O) -> Self::Output

Performs the & operation.

impl<O: Into<EnumSet<Option>>> BitOr<O> for Option

type Output = EnumSet<Option>

The resulting type after applying the | operator.

fn bitor(self, other: O) -> Self::Output

Performs the | operation.

impl<O: Into<EnumSet<Option>>> BitXor<O> for Option

type Output = EnumSet<Option>

The resulting type after applying the ^ operator.

fn bitxor(self, other: O) -> Self::Output

Performs the ^ operation.

impl Clone for Option

fn clone(&self) -> Option

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Option

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

Formats the value using the given formatter.

impl Display for Option

Prints the option name, all in lower case without punctuations.

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

Formats the value using the given formatter.

impl EnumSetTypePrivate for Option

const CONST_HELPER_INSTANCE: __EnumSetConstHelper = __EnumSetConstHelper

The instance of the ConstHelper.

const ALL_BITS: Self::Repr = {transmute(0x0007ffff): <option::Option as enumset::__internal::EnumSetTypePrivate>::Repr}

A mask of bits that are valid in the bitset.

const BIT_WIDTH: u32 = 19u32

The largest bit used in the bitset.

const VARIANT_COUNT: u32 = 19u32

The number of variants in the bitset.

type ConstHelper = __EnumSetConstHelper

A helper type used to implement the enum_set! macro among other things.

type Repr = u32

The underlying type used to store the bitset.

fn enum_into_u32(self) -> u32

Converts an enum of this type into its bit position.

unsafe fn enum_from_u32(val: u32) -> Self

Converts a bit position into an enum value.

impl Extend<Option> for OptionSet

fn extend<T: IntoIterator<Item = Option>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl FromStr for Option

Parses an option name.

The input string should be a canonical option name, that is, all the characters should be lowercase and there should be no punctuations or other irrelevant characters. You can canonicalize the name before parsing it.

The option name may be abbreviated as long as it is an unambiguous prefix of a valid option name. For example, Option::from_str("clob") will return Ok(Clobber) like Option::from_str("clobber"). If the name is ambiguous, from_str returns Err(Ambiguous). A full option name is never considered ambiguous. For example, "log" is not ambiguous even though it is also a prefix of another valid option "login".

Note that new options may be added in the future, which can turn an unambiguous option name into an ambiguous one. You should use full option names for maximum compatibility.

type Err = FromStrError

The associated error which can be returned from parsing.

fn from_str(name: &str) -> Result<Self, FromStrError>

Parses a string s to return a value of this type.

impl Hash for Option

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 Not for Option

type Output = EnumSet<Option>

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl PartialEq<EnumSet<Option>> for Option

fn eq(&self, other: &EnumSet<Option>) -> 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 PartialEq for Option

fn eq(&self, other: &Option) -> 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<O: Into<EnumSet<Option>>> Sub<O> for Option

type Output = EnumSet<Option>

The resulting type after applying the - operator.

fn sub(self, other: O) -> Self::Output

Performs the - operation.

impl Copy for Option

impl EnumSetType for Option

impl Eq for Option

impl StructuralPartialEq for Option