Enum ParserPath

pub enum ParserPath {
    RealPath(PathBuf),
    VirtualFile(PathBuf, usize),
    VirtualDir(PathBuf, Vec<ParserPath>),
}

An abstraction over a PathBuf that can have virtual paths (files and directories). Virtual paths always exist and represent a way to ship Nushell code inside the binary without requiring paths to be present in the file system.

Created from VirtualPath found in the engine state.

Variants

RealPath(PathBuf)

VirtualFile(PathBuf, usize)

VirtualDir(PathBuf, Vec<ParserPath>)

Implementations

impl ParserPath

pub fn is_dir(&self) -> bool

pub fn is_file(&self) -> bool

pub fn exists(&self) -> bool

pub fn path(&self) -> &Path

pub fn path_buf(self) -> PathBuf

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

pub fn read_dir(&self) -> Option<Vec<ParserPath>>

pub fn file_stem(&self) -> Option<&OsStr>

pub fn extension(&self) -> Option<&OsStr>

pub fn join(self, path: impl AsRef<Path>) -> ParserPath

pub fn open<'a>( &'a self, working_set: &'a StateWorkingSet<'_>, ) -> Result<Box<dyn Read + 'a>>

pub fn read<'a>( &'a self, working_set: &'a StateWorkingSet<'_>, ) -> Option<Vec<u8>>

pub fn from_virtual_path( working_set: &StateWorkingSet<'_>, name: &str, virtual_path: &VirtualPath, ) -> Self

Trait Implementations

impl Clone for ParserPath

fn clone(&self) -> ParserPath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ParserPath

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

Formats the value using the given formatter.

impl Ord for ParserPath

fn cmp(&self, other: &ParserPath) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ParserPath

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

fn partial_cmp(&self, other: &ParserPath) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for ParserPath

impl StructuralPartialEq for ParserPath