Enum TreeError 

#[non_exhaustive]
pub enum TreeError {
    ManifestNotFound(PathBuf),
    ManifestRead(String),
    ManifestPermissionDenied {
        path: PathBuf,
    },
    ManifestNotADir {
        path: PathBuf,
    },
    ManifestIo {
        path: PathBuf,
        source: Error,
    },
    ManifestParse {
        path: PathBuf,
        detail: String,
    },
    Git(GitError),
    CycleDetected {
        chain: Vec<String>,
    },
    PackNameMismatch {
        got: String,
        expected: String,
        path: PathBuf,
    },
    ChildPathInvalid {
        child_name: String,
        path: String,
        reason: String,
    },
    LegacyLockfileDetected {
        path: PathBuf,
    },
    UntrackedGitRepos {
        paths: Vec<PathBuf>,
    },
    DirtyTreeRefusal {
        path: PathBuf,
        kind: DirtyTreeRefusalKind,
    },
    ManifestPathEscape {
        path: String,
        reason: String,
    },
    InvalidDestination {
        path: PathBuf,
        reason: String,
    },
}

Errors raised during a pack-tree walk.

Marked #[non_exhaustive] so later slices (credentials, submodules, partial walks) can add variants without breaking consumers.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

ManifestNotFound(PathBuf)

The walker expected a pack.yaml at the given location but could not find one (or its enclosing .grex/ directory was missing).

ManifestRead(String)

The manifest file existed but could not be read from disk.

Catch-all fallback for io::ErrorKind cases that do not match a categorised variant. Prefer TreeError::ManifestPermissionDenied, TreeError::ManifestNotADir, or TreeError::ManifestIo when the producer can route via io::Error::kind() / is_not_a_directory. Retained for back-compat: v1.2.0+ downstream consumers may have matched this variant explicitly.

ManifestPermissionDenied

Manifest existed but the OS denied read access (POSIX EACCES / Windows ERROR_ACCESS_DENIED). Operator-actionable: chmod / icacls to grant the running user read on the file.

Fields

path: PathBuf

On-disk location of the unreadable manifest.

ManifestNotADir

Manifest path resolved to a non-directory entry where a directory was expected (or the parent of the manifest path is not a directory). Distinct from TreeError::ManifestNotFound — the path exists but has the wrong type. Surfaces as ENOTDIR / ERROR_DIRECTORY on the producer side; detection routed through is_not_a_directory for MSRV 1.79 compatibility.

Fields

path: PathBuf

On-disk location whose type prevented manifest read.

ManifestIo

Generic IO failure reading a manifest, preserving the underlying io::Error for log routing without forcing the caller to re-open the file. The catch-all path before the loader falls through to TreeError::ManifestRead for kinds that don’t match a categorised variant.

Fields

path: PathBuf

On-disk location of the manifest whose read failed.

source: Error

Underlying OS error preserved for the std::error::Error source chain.

ManifestParse

The manifest file was read but did not parse as a valid pack.yaml.

Fields

path: PathBuf

On-disk location of the manifest that failed to parse.

detail: String

Backend-provided failure detail.

Git(GitError)

A git operation (clone, fetch, checkout, …) failed while hydrating a child pack. The underlying GitError is preserved in full.

CycleDetected

A cycle was detected during the walk. chain lists the pack URLs (or paths for the root) from the outermost pack down to the recurrence.

Fields

chain: Vec<String>

Ordered chain of pack identities that forms the cycle.

PackNameMismatch

A cloned child’s pack.yaml declared a name that does not match what the parent pack expected for that children: entry.

Fields

got: String

Name declared in the child’s own manifest.

expected: String

Name the parent expected (derived from the child entry’s effective path).

path: PathBuf

On-disk location of the offending child.

ChildPathInvalid

A children[].path (or URL-derived tail) violated the bare-name rule. Surfaced by the walker BEFORE any clone of the offending child fires so a malicious path: ../escape in a parent pack cannot materialise a directory outside the pack root. This is a security boundary, not a soft validation concern — see crates/grex-core/src/pack/validate/child_path.rs for the shared rejection logic.

Fields

child_name: String

Label of the offending child (the explicit path: value, or the URL-derived tail when path: is omitted).

path: String

The rejected literal value.

reason: String

One-line explanation of which sub-rule failed.

LegacyLockfileDetected

A v1.1.1-shape lockfile was encountered without the --migrate-lockfile opt-in. v1.2.0 changed the on-disk lockfile schema; the operator must explicitly run the migrator to convert pre-existing lockfiles. Emitted by Stage 1.h walker entry-point before any pack-tree work begins. Dormant until 1.h wires the detector.

Fields

path: PathBuf

On-disk location of the legacy lockfile.

UntrackedGitRepos

One or more declared children own a .git/ directory but lack a .grex/pack.yaml, and the v1.2.0 nested-children semantics preclude the v1.1.1 “synthesize plain-git pack” fallback (e.g. because a sibling explicitly opted out, or the parent manifest disabled synthesis). Aggregated by Stage 1.e Phase 1; the walker reports every offender in one go so the operator can fix the manifest with a single pass.

Fields

paths: Vec<PathBuf>

Paths (relative to the parent pack root) of every offender.

DirtyTreeRefusal

Stage 1.f Phase 2 prune refused to remove a destination because the recursive consent walk returned a non-Clean verdict. kind discriminates the specific safety violation so the CLI can suggest the correct override flag.

Fields

path: PathBuf

Pack-tree-relative path of the destination the walker refused to prune.

kind: DirtyTreeRefusalKind

Specific consent violation that triggered the refusal.

ManifestPathEscape

Stage 1.c validator rejected a child manifest segment that resolved outside the parent pack root. Distinct from TreeError::ChildPathInvalid — that variant rejects the literal path: syntax (slashes, dots, absolute paths); ManifestPathEscape is the post-resolution boundary check that catches symlink-driven and platform-specific escapes.

Fields

path: String

The literal manifest path that resolved out of bounds.

reason: String

One-line explanation of which rule the resolved path violated.

InvalidDestination

v1.3.1 (B4) — a child’s resolved on-disk destination has no usable UTF-8 file_name component. Surfaces during dry-run record construction when dest.file_name() returns None (e.g. the path ends in .. or is a filesystem root) or the component is not UTF-8. Recording the child with an empty id would silently corrupt the dry-run plan, so the walker pushes this error into SyncMetaReport.errors instead and continues.

Fields

path: PathBuf

On-disk destination path that lacked a usable file_name.

reason: String

One-line explanation of which rule the path violated.

Trait Implementations

impl Debug for TreeError

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

Formats the value using the given formatter.

impl Display for TreeError

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

Formats the value using the given formatter.

impl Error for TreeError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<GitError> for TreeError

fn from(source: GitError) -> Self

Converts to this type from the input type.

impl From<TreeError> for SyncError

fn from(source: TreeError) -> Self

Converts to this type from the input type.