draftline 0.2.4

Git-native versioning for creative content workflows.
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

use std::path::PathBuf;

use crate::{PreflightReport, RecoveryState, SyncStatus};

/// Result type used by Draftline APIs.
pub type Result<T> = std::result::Result<T, DraftlineError>;

/// Errors returned by Draftline.
#[derive(Debug, thiserror::Error)]
pub enum DraftlineError {
    #[error("git operation failed: {0}")]
    Git(#[from] git2::Error),

    #[error("I/O operation failed: {0}")]
    Io(#[from] std::io::Error),

    #[error("recovery metadata operation failed: {0}")]
    Json(#[from] serde_json::Error),

    #[error("path escapes the workspace: {0}")]
    PathEscapesWorkspace(PathBuf),

    #[error("absolute paths are not accepted for workspace-relative operations: {0}")]
    AbsolutePath(PathBuf),

    #[error(
        "workspace has unsaved changes; choose an explicit policy before switching variations"
    )]
    WorkspaceDirty,

    #[error("operation preflight failed")]
    PreflightFailed(Box<PreflightReport>),

    #[error("workspace has an incomplete Draftline operation")]
    RecoveryRequired(Box<RecoveryState>),

    #[error("recovery operation was not found: {0}")]
    RecoveryNotFound(String),

    #[error("invalid variation name: {0}")]
    InvalidVariationName(String),

    #[error("variation already exists: {0}")]
    VariationAlreadyExists(String),

    #[error("variation was not found: {0}")]
    VariationNotFound(String),

    #[error("cannot delete the current variation: {0}")]
    CannotDeleteCurrentVariation(String),

    #[error("version was not found: {0}")]
    VersionNotFound(String),

    #[error("workspace has no current variation")]
    NoCurrentVariation,

    #[error("workspace is locked by another Draftline operation")]
    WorkspaceLocked,

    #[error("unsupported switch policy: {0}")]
    UnsupportedSwitchPolicy(&'static str),

    #[error("invalid content policy path: {0}")]
    InvalidContentPolicyPath(PathBuf),

    #[error("invalid content policy extension: {0}")]
    InvalidContentPolicyExtension(String),

    #[error("path is outside tracked content policy: {0}")]
    PathOutsideContentPolicy(PathBuf),

    #[error("remote has incoming changes that need an explicit merge plan")]
    SyncNeedsMerge(Box<SyncStatus>),

    #[error(
        "remote state changed for {remote}/{variation}; expected {expected:?}, actual {actual:?}"
    )]
    RemoteRace {
        remote: String,
        variation: String,
        expected: Option<String>,
        actual: Option<String>,
    },

    #[error("local publish state changed; expected {expected}, actual {actual}")]
    LocalStateChanged { expected: String, actual: String },

    #[error("operation requires explicit confirmation: {0}")]
    ConsentRequired(String),

    #[error("squash requires at least 2 versions, got {0}")]
    InvalidSquashCount(usize),

    #[error("not enough versions to squash: need {needed}, available {available}")]
    NotEnoughVersionsToSquash { needed: usize, available: usize },

    #[error("invalid contributor identity: {0}")]
    InvalidContributorIdentity(String),

    #[error("invalid merge resolution: {0}")]
    InvalidMergeResolution(String),
}