Struct nu_protocol::engine::FileStack

pub struct FileStack(/* private fields */);

Files being evaluated, arranged as a stack.

The current active file is on the top of the stack. When a file source/import another file, the new file is pushed onto the stack. Attempting to add files that are already in the stack (circular import) results in an error.

Note that file paths are compared without canonicalization, so the same physical file may still appear multiple times under different paths. This doesn’t affect circular import detection though.

Implementations

impl FileStack

pub fn new() -> Self

Creates an empty stack.

pub fn with_file(path: PathBuf) -> Self

Creates a stack with a single file on top.

This is a convenience method that creates an empty stack, then pushes the file onto it. It skips the circular import check and always succeeds.

pub fn push(&mut self, path: PathBuf, span: Span) -> Result<(), ParseError>

Adds a file to the stack.

If the same file is already present in the stack, returns ParseError::CircularImport.

pub fn pop(&mut self) -> Option<PathBuf>

Removes a file from the stack and returns its path, or None if the stack is empty.

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

Returns the active file (that is, the file on the top of the stack), or None if the stack is empty.

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

Returns the parent directory of the active file, or None if the stack is empty or the active file doesn’t have a parent directory as part of its path.

Trait Implementations

impl Debug for FileStack

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

Formats the value using the given formatter.

impl Default for FileStack

fn default() -> FileStack

Returns the “default value” for a type.