Struct jj_lib::repo_path::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>) -> Self

Creates RepoPathBuf from valid string representation.

The input value must not contain empty path components. For example, "/", "/foo", "foo/", "foo//bar" are all invalid.

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

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 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 copy of the value.

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

Performs copy-assignment from source.

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 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for RepoPathBuf

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

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method 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

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for RepoPathBuf

impl StructuralPartialEq for RepoPathBuf