grex-core 1.1.0

Core library for grex, the nested meta-repo manager: manifest, lockfile, scheduler, pack model, plugin traits.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! Error taxonomy for the [`crate::git`] backend.
//!
//! Errors carry `String` detail fields rather than boxing underlying `gix`
//! error types. Keeping the public API free of leaky backend types means the
//! trait surface stays stable across backend swaps and `#[non_exhaustive]`
//! can be safely extended in future slices (e.g. auth, shallow, submodules).

use std::path::PathBuf;

use thiserror::Error;

/// Errors produced by any [`crate::git::GitBackend`] implementation.
///
/// The enum is `#[non_exhaustive]` so future slices (credentials, submodules,
/// partial fetch) can add variants without a breaking change.
#[non_exhaustive]
#[derive(Debug, Error)]
pub enum GitError {
    /// Clone was asked to populate a destination that already contains files.
    #[error("destination `{0}` is not empty")]
    DestinationNotEmpty(PathBuf),

    /// Operation was asked to act on a path that does not hold a git repo.
    #[error("path `{0}` is not a git repository")]
    NotARepository(PathBuf),

    /// A ref (branch, tag, or SHA) could not be resolved in the repository.
    #[error("ref `{0}` not found in repository")]
    RefNotFound(String),

    /// Checkout refused because the working tree has uncommitted changes.
    #[error("working tree has uncommitted changes at `{0}`")]
    DirtyWorkingTree(PathBuf),

    /// Clone failed at the backend layer. `detail` carries the backend
    /// message verbatim for operator diagnosis.
    #[error("clone from `{url}` failed: {detail}")]
    CloneFailed {
        /// Remote URL that was being cloned.
        url: String,
        /// Backend-provided failure detail.
        detail: String,
    },

    /// Fetch failed at the backend layer.
    #[error("fetch failed at `{0}`: {1}")]
    FetchFailed(PathBuf, String),

    /// Checkout of a resolved ref failed to apply to the working tree.
    #[error("checkout of `{r#ref}` failed: {detail}")]
    CheckoutFailed {
        /// Ref name (branch, tag, or SHA) that was being checked out.
        r#ref: String,
        /// Backend-provided failure detail.
        detail: String,
    },

    /// Catch-all for unexpected backend errors. Carries the detail string so
    /// the caller can log or surface it without losing information.
    #[error("gix internal error: {0}")]
    Internal(String),
}