Enum Source 

pub enum Source {
    File(PathBuf),
    Environment,
    Prompt,
    Shell,
}

Where a frame’s code came from, as BASH_SOURCE names it. Two of bash’s words are not paths at all.

Variants

File(PathBuf)

Absolute, by joining what bash reported onto the walk’s own $PWD. Nothing is resolved: no symlink is followed and no .. collapsed.

Whether the file is there is found and not this: bash keeps a source path as it was written, and a shell that has since changed directory leaves a relative one pointing nowhere.

Environment

environment: the function came in through the environment.

Prompt

main: the function was defined at an interactive prompt.

Shell

The code bash was given rather than read: a -c command line, or standard input. Bash writes $0 here, which is a word and not a path.

Implementations

impl Source

pub fn found(&self) -> Option<&Path>

The file, if this names one and it is there.

pub fn missing(&self) -> Option<&Path>

The path this names but does not have, which is a source the run cannot be read against.

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<'de> Deserialize<'de> for Source

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Source

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

Formats the value using the given formatter.

impl Eq for Source

impl PartialEq for Source

fn eq(&self, other: &Source) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for Source

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Source