Struct RepositoryRoot 

pub struct RepositoryRoot(PathBuf);

A canonical repository root directory.

The only constructor canonicalizes the path, so every value holds an absolute path with no symlinks in it.

Tuple Fields

0: PathBuf

Implementations

impl RepositoryRoot

pub fn new(path: &Path) -> Result<Self, PathError>

Canonicalize path into a repository root.

Errors

Returns an error when the path does not exist or cannot be read.

pub fn discover(start: &Path) -> Result<Self, FilesError>

The root of the work tree that holds start, found by searching upwards.

Errors

Returns an error when start is not inside a repository with a work tree.

pub fn as_path(&self) -> &Path

The canonical absolute path.

pub fn relative(&self, path: &Path) -> Result<RepositoryPath, PathError>

The repository-relative form of an absolute path below this root.

Errors

Returns an error when path is not below the root or is not a valid repository path.

impl RepositoryRoot

pub fn read(&self, path: &RepositoryPath) -> Result<Option<Vec<u8>>, FilesError>

The content of the file at path, or None when nothing exists there.

Errors

Returns an error when a parent or the file itself is a symlink or the file cannot be read.

Trait Implementations

impl Clone for RepositoryRoot

fn clone(&self) -> RepositoryRoot

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RepositoryRoot

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

Formats the value using the given formatter.

impl Eq for RepositoryRoot

impl PartialEq for RepositoryRoot

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for RepositoryRoot