Struct ProjectPaths 

pub struct ProjectPaths { /* private fields */ }

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

Cloning this type clones only an Arc. The project root, exact source bytes, declaration-ordered entries, and lookup index remain in one shared immutable allocation.

Implementations

impl ProjectPaths

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

Loads the standard config/paths.json beneath project_root.

project_root is retained exactly as supplied. Relative configured paths are later joined to it lexically; neither the root nor configured values are canonicalized.

Errors

Returns contextual file or JSON errors, recursive duplicate-key errors, or ConfigurationError::InvalidConfigurationDocument when the root is not an object or a key has a non-string or empty path value.

pub fn project_root(&self) -> &Path

Returns the project root exactly as supplied at load time.

pub fn source_path(&self) -> &Path

Returns the derived config/paths.json source path.

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

Borrows the validated original bytes of paths.json unchanged.

The slice preserves whitespace, declaration order, escaping, and every other byte-level source detail.

pub fn len(&self) -> usize

Returns the number of declared path names.

pub fn is_empty(&self) -> bool

Reports whether paths.json declares no entries.

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

Reports whether an exact, case-sensitive path key is declared.

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

Borrows one configured path exactly as represented by its JSON string.

Relative values remain relative. Missing keys return None; no filesystem operation or allocation occurs.

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

Borrows one required configured path or returns its exact missing key.

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

Returns one path resolved lexically against the project root.

Absolute configured paths are returned unchanged. Relative paths are joined with ProjectPaths::project_root. The result is not canonicalized, normalized, opened, or checked for existence.

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

Iterates exact path keys in JSON declaration order.

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

Iterates declaration-ordered exact keys and unresolved path values.

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 only the project root, source path, and entry count.