Struct RepoPath

Source

pub struct RepoPath { /* private fields */ }

Expand description

Borrowed repository path.

Implementations§

Source §

impl RepoPath

Source

pub const fn root() -> &'static RepoPath

Returns repository path pointing to the root.

Source

pub fn from_internal_string( value: &str, ) -> Result<&RepoPath, InvalidNewRepoPathError>

Wraps valid string representation as RepoPath.

Returns an error if the input value contains empty path component. For example, "/", "/foo", "foo/", "foo//bar" are all invalid.

Source

pub fn to_internal_dir_string(&self) -> String

The full string form used internally, not for presenting to users (where we may want to use the platform’s separator). This format includes a trailing slash, unless this path represents the root directory. That way it can be concatenated with a basename and produce a valid path.

Source

pub fn as_internal_file_string(&self) -> &str

The full string form used internally, not for presenting to users (where we may want to use the platform’s separator).

Source

pub fn to_fs_path(&self, base: &Path) -> Result<PathBuf, InvalidRepoPathError>

Converts repository path to filesystem path relative to the base.

The returned path should never contain .., C: (on Windows), etc. However, it may contain reserved working-copy directories such as .jj.

Source

pub fn to_fs_path_unchecked(&self, base: &Path) -> PathBuf

Converts repository path to filesystem path relative to the base, without checking invalid path components.

The returned path may point outside of the base directory. Use this function only for displaying or testing purposes.

Source

pub fn is_root(&self) -> bool

Returns true if this is a root path.

Source

pub fn starts_with(&self, base: &RepoPath) -> bool

Returns true if the base is a prefix of this path.

Source

pub fn strip_prefix(&self, base: &RepoPath) -> Option<&RepoPath>

Returns the remaining path with the base path removed.

Source

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

Returns the parent path without the base name component.

Source

pub fn split(&self) -> Option<(&RepoPath, &RepoPathComponent)>

Splits this into the parent path and base name component.

Source

pub fn components(&self) -> RepoPathComponentsIter<'_> ⓘ

Iterator over the path’s components, with parents before children.

For example, RepoPath::from_internal_string("a/b/c")?.components() yields “a”, “b”, “c”.

Source

pub fn ancestors(&self) -> impl Iterator<Item = &RepoPath>

Iterator over the path’s ancestors, with children before parents.

For example, RepoPath::from_internal_string("a/b/c")?.ancestors() yiels “a/b/c”, “a/b”, “a”, “”.

Source

pub fn join(&self, entry: &RepoPathComponent) -> RepoPathBuf

Join the given entry on the Path returning a new RepoPathBuf.

Source

pub fn split_common_prefix(&self, other: &RepoPath) -> (&RepoPath, &RepoPath)

Splits this path at its common prefix with other.

§Returns

Returns the (common_prefix, self_remainder).

All paths will at least have RepoPath::root() as a common prefix, therefore even if self and other have no matching parent component this function will always return at least (RepoPath::root(), self).

§Examples

use jj_core::repo_path::RepoPath;

let bing_path = RepoPath::from_internal_string("foo/bar/bing").unwrap();

let baz_path = RepoPath::from_internal_string("foo/bar/baz").unwrap();

let foo_bar_path = RepoPath::from_internal_string("foo/bar").unwrap();

assert_eq!(
    bing_path.split_common_prefix(&baz_path),
    (foo_bar_path, RepoPath::from_internal_string("bing").unwrap())
);

let unrelated_path = RepoPath::from_internal_string("no/common/prefix").unwrap();
assert_eq!(
    baz_path.split_common_prefix(&unrelated_path),
    (RepoPath::root(), baz_path)
);