Struct RepoPath

pub struct RepoPath { /* private fields */ }

Borrowed repository path.

Implementations

impl RepoPath

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

Returns repository path pointing to the root.

pub fn from_internal_string( value: &str, ) -> Result<&Self, 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.

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.

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).

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.

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.

pub fn is_root(&self) -> bool

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

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

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

Returns the remaining path with the base path removed.

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

Returns the parent path without the base name component.

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

Splits this into the parent path and base name component.

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

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

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

Trait Implementations

impl AsRef<RepoPath> for RepoPath

fn as_ref(&self) -> &RepoPath

Converts this type into a shared reference of the (usually inferred) input type.

impl AsRef<RepoPath> for RepoPathBuf

fn as_ref(&self) -> &RepoPath

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<RepoPath> for RepoPathBuf

fn borrow(&self) -> &RepoPath

Immutably borrows from an owned value.

impl ContentHash for RepoPath

fn hash(&self, state: &mut impl Update)

Update the hasher state with this object’s content

impl Debug for RepoPath

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

Formats the value using the given formatter.

impl Hash for RepoPath

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

impl Ord for RepoPath

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

This method returns an Ordering between self and other.

impl PartialEq for RepoPath

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

fn partial_cmp(&self, other: &Self) -> 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 ToOwned for RepoPath

type Owned = RepoPathBuf

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

Uses borrowed data to replace owned data, usually by cloning.

impl Eq for RepoPath

impl StructuralPartialEq for RepoPath