Struct RepoPathBuf

pub struct RepoPathBuf { /* private fields */ }

Owned repository path.

Implementations

impl RepoPathBuf

pub const fn root() -> Self

Creates owned repository path pointing to the root.

pub fn from_internal_string( value: impl Into<String>, ) -> Result<Self, InvalidNewRepoPathError>

Creates RepoPathBuf from valid string representation.

pub fn from_relative_path( relative_path: impl AsRef<Path>, ) -> Result<Self, RelativePathParseError>

Converts repo-relative Path to RepoPathBuf.

The input path should not contain redundant . or ...

pub fn parse_fs_path( cwd: &Path, base: &Path, input: impl AsRef<Path>, ) -> Result<Self, FsPathParseError>

Parses an input path into a RepoPathBuf relative to base.

The cwd and base paths are supposed to be absolute and normalized in the same manner. The input path may be either relative to cwd or absolute.

pub fn into_internal_string(self) -> String

Consumes this and returns the underlying string representation.

Methods from Deref<Target = RepoPath>

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 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 Clone for RepoPathBuf

fn clone(&self) -> RepoPathBuf

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl ContentHash for RepoPathBuf

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

Update the hasher state with this object’s content

impl Debug for RepoPathBuf

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

Formats the value using the given formatter.

impl Deref for RepoPathBuf

type Target = RepoPath

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<P: AsRef<RepoPathComponent>> Extend<P> for RepoPathBuf

fn extend<T: IntoIterator<Item = P>>(&mut self, iter: T)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl Hash for RepoPathBuf

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

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for RepoPathBuf

fn cmp(&self, other: &Self) -> 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 RepoPathBuf

fn eq(&self, other: &RepoPathBuf) -> bool

Tests for self and other values to be equal, and is used by ==.

const 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 RepoPathBuf

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 Serialize for RepoPathBuf

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for RepoPathBuf

impl StructuralPartialEq for RepoPathBuf