Struct ProjectPaths 

pub struct ProjectPaths { /* private fields */ }

A validated read-only dictionary of project-wide named filesystem paths.

Loading preserves declaration order and exact source bytes. It does not canonicalize paths, inspect targets, or require targets to exist.

Implementations

impl ProjectPaths

pub fn load( project_root: impl Into<PathBuf>, ) -> Result<Self, ConfigurationError>

Loads the standard config/paths.json beneath project_root.

pub fn project_root(&self) -> &Path

Returns the project root supplied to Self::load.

pub fn source_path(&self) -> &Path

Returns the exact paths.json source path.

pub fn source_json(&self) -> &[u8]

Borrows the original validated source bytes without reserialization.

pub fn len(&self) -> usize

Returns the number of declared named paths.

pub fn is_empty(&self) -> bool

Reports whether the path table contains no entries.

pub fn contains(&self, key: &str) -> bool

Reports whether key is declared.

pub fn path(&self, key: &str) -> Option<&Path>

Borrows the declared path without resolving it against the project root.

pub fn require_path(&self, key: &str) -> Result<&Path, ConfigurationError>

Borrows a required declared path or returns an unknown-path error.

pub fn resolve_path(&self, key: &str) -> Result<PathBuf, ConfigurationError>

Returns an absolute declaration unchanged or joins a relative one to the project root.

pub fn keys(&self) -> impl ExactSizeIterator<Item = &str>

Iterates names in source declaration order.

pub fn iter(&self) -> impl ExactSizeIterator<Item = (&str, &Path)>

Iterates names and unresolved paths in source declaration order.

pub fn to_json_value(&self) -> Value

Returns a deterministic JSON object suitable for task provenance.

Trait Implementations

impl Clone for ProjectPaths

fn clone(&self) -> ProjectPaths

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProjectPaths

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

Formats the value using the given formatter.