Enum Source 

#[non_exhaustive]
pub enum Source {
    Unknown,
    Stdin,
    CommandString,
    CommandFile {
        path: String,
    },
    Alias {
        original: Location,
        alias: Rc<Alias>,
    },
    CommandSubst {
        original: Location,
    },
    Arith {
        original: Location,
    },
    Eval {
        original: Location,
    },
    DotScript {
        name: String,
        origin: Location,
    },
    Trap {
        condition: String,
        origin: Location,
    },
    VariableValue {
        name: String,
    },
    InitFile {
        path: String,
    },
    Other {
        label: String,
    },
}

Origin of source code

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.

Unknown

Source code of unknown origin

Normally you should not use this value, but it may be useful for quick debugging.

Stdin

Standard input

CommandString

Command string specified with the -c option on the shell startup

CommandFile

File specified on the shell startup

Fields

path: String

Alias

Alias substitution

This applies to a code fragment that replaced another as a result of alias substitution.

Fields

original: Location

Position of the original word that was replaced

alias: Rc<Alias>

Definition of the alias that was substituted

CommandSubst

Command substitution

Fields

original: Location

Arith

Arithmetic expansion

Fields

original: Location

Eval

Command string executed by the eval built-in

Fields

original: Location

DotScript

File executed by the . (source) built-in

Fields

name: String

Pathname of the file

origin: Location

Location of the simple command that invoked the . built-in

Trap

Trap command

Fields

condition: String

Trap condition name, typically the signal name

origin: Location

Location of the simple command that has set this trap command

VariableValue

Value of a variable

Fields

name: String

Variable name

InitFile

File executed during shell startup

Fields

path: String

Other

Other source

Fields

label: String

Label that describes the source

Implementations

impl Source

pub fn extend_with_context<'a>(&'a self, snippets: &mut Vec<Snippet<'a>>)

Extends the given vector of snippets with spans annotating the context of this source.

If self is a source that has a related location (e.g., the original field of CommandSubst), this method adds one or more spans describing the location to the given vector. If the code of the location is already present in the vector, it adds the span to the existing snippet; otherwise, it creates a new snippet.

If self does not have a related location, this method does nothing.

impl Source

pub fn is_alias_for(&self, name: &str) -> bool

Tests if this source is alias substitution for the given name.

Returns true if self is Source::Alias with the name or such an original, recursively.

// `is_alias_for` returns false for sources other than an Alias
assert_eq!(Source::Unknown.is_alias_for("foo"), false);

// `is_alias_for` returns true if the names match
let original = Location::dummy("");
let alias = std::rc::Rc::new(yash_env::alias::Alias {
    name: "foo".to_string(),
    replacement: "".to_string(),
    global: false,
    origin: original.clone()
});
let source = Source::Alias { original, alias };
assert_eq!(source.is_alias_for("foo"), true);
assert_eq!(source.is_alias_for("bar"), false);

// `is_alias_for` checks aliases recursively.
let original = Location::dummy("");
let alias = Rc::new(yash_env::alias::Alias {
    name: "foo".to_string(),
    replacement: "".to_string(),
    global: false,
    origin: original.clone(),
});
let source = Source::Alias { original, alias };
let alias = Rc::new(yash_env::alias::Alias {
    name: "bar".to_string(),
    replacement: "".to_string(),
    global: false,
    origin: Location::dummy(""),
});
let mut original = Location::dummy("");
Rc::make_mut(&mut original.code).source = Rc::new(source);
let source = Source::Alias { original, alias };
assert_eq!(source.is_alias_for("foo"), true);
assert_eq!(source.is_alias_for("bar"), true);
assert_eq!(source.is_alias_for("baz"), false);

pub fn label(&self) -> &str

Returns a label that describes the source.

Trait Implementations

impl Clone for Source

fn clone(&self) -> Source

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Source

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

Formats the value using the given formatter.

impl PartialEq for Source

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

impl StructuralPartialEq for Source