Struct Mode 

#[non_exhaustive]
pub struct Mode {
    pub portable: bool,
}

Parsing mode derived from shell options

Some shell options change which syntax the parser accepts. This type conveys the relevant option states from the shell environment to the parser and lexer, so that the parser does not need to depend on the whole OptionSet. The standard parser (yash-syntax) reads it from the lexer and adjusts the syntax it accepts accordingly.

A Mode is typically created from the current option set by converting an OptionSet with the From implementation. The default mode permits all syntax (every field is false), so the parser behaves as if no restricting option were set.

This struct is #[non_exhaustive] because more fields may be added as more parsing-affecting options are supported. You can still create one by starting from Default or a converted OptionSet and assigning to individual fields.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

portable: bool

Whether the parser rejects non-portable syntax

This reflects the Portable shell option. When true, the parser reports an error on constructs that are valid in yash but not portable across POSIX-conforming shells.

Trait Implementations

impl Clone for Mode

fn clone(&self) -> Mode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Mode

impl Debug for Mode

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

Formats the value using the given formatter.

impl Default for Mode

fn default() -> Mode

Returns the “default value” for a type.

impl Eq for Mode

impl From<&OptionSet> for Mode

Creates a Mode reflecting the given option set.

fn from(options: &OptionSet) -> Self

Converts to this type from the input type.

impl Hash for Mode

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 PartialEq for Mode

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