Struct Workspace 

pub struct Workspace { /* private fields */ }

A project root that all reads are confined to.

Implementations

impl Workspace

pub fn at(root: &Path) -> Option<Self>

A workspace rooted at root (which must exist).

pub fn root(&self) -> &Path

The canonical root.

pub fn resolve(&self, rel: &str) -> Result<PathBuf, ReadError>

Resolves a workspace-relative path to an existing path inside the root.

pub fn is_file(&self, rel: &str) -> bool

Whether rel is a file inside the root.

pub fn is_dir(&self, rel: &str) -> bool

Whether rel is a directory inside the root.

pub fn read_text(&self, rel: &str) -> Result<String, ReadError>

Reads a UTF-8 file inside the root, refusing files above the size limit.

pub fn read_text_limited( &self, rel: &str, limit: u64, ) -> Result<String, ReadError>

Self::read_text with an explicit size limit (e.g. large test reports).

pub fn list_dirs(&self, rel: &str) -> Result<DirListing, ReadError>

Names of the directory entries of rel that are directories, split into those inside the root and those resolving outside it.

Trait Implementations

impl Clone for Workspace

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Workspace

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

Formats the value using the given formatter.