Struct git_repository::worktree::fs::Stack

pub struct Stack { /* private fields */ }

A stack of path components with the delegation of side-effects as the currently set path changes, component by component.

Implementations

impl Stack

pub fn root(&self) -> &Path

Returns the top-level path of the stack.

pub fn current(&self) -> &Path

Returns the absolute path the currently set path.

pub fn current_relative(&self) -> &Path

Returns the currently set path relative to the root().

impl Stack

pub fn new(root: impl Into<PathBuf>) -> Stack

Create a new instance with root being the base for all future paths we handle, assuming it to be valid which includes symbolic links to be included in it as well.

pub fn make_relative_path_current(
    &mut self,
    relative: impl AsRef<Path>,
    delegate: &mut impl Delegate
) -> Result<(), Error>

Set the current stack to point to the relative path and call push_comp() each time a new path component is popped along with the stacks state for inspection to perform an operation that produces some data.

The full path to relative will be returned along with the data returned by push_comp. Note that this only works correctly for the delegate’s push_directory() and pop_directory() methods if relative paths are terminal, so point to their designated file or directory.

Trait Implementations

impl Clone for Stack

fn clone(&self) -> Stack

Returns a copy of the value.

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

Performs copy-assignment from source.