treeboot-core 0.9.0

Reusable worktree bootstrap engine for the treeboot CLI.
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

//! Core library for `treeboot`.
//!
//! This crate contains the reusable worktree bootstrap logic. The `treeboot`
//! binary crate provides the command-line interface on top of this API.

#![deny(missing_docs)]

mod check;
mod commands;
mod config;
mod context;
mod discovery;
mod doctor;
mod env;
mod error;
mod executor;
mod file_actions;
mod file_execution;
mod file_operations;
mod file_planning;
mod file_system;
mod git;
mod init;
mod manual;
mod metadata;
mod output;
mod path_filter;
mod paths;
mod run;
mod runtime;
mod status;
#[cfg(test)]
mod test_support;
mod validation;

pub use check::{CheckAction, CheckOptions, CheckReport, WorktreeSnapshot, check};
pub use context::{Environment, EnvironmentInput, Worktree, WorktreeOptions};
pub use discovery::{IgnoredInitScript, InitScriptDiscovery};
pub use doctor::{Diagnostic, DiagnosticStatus, DoctorOptions, DoctorReport, diagnose};
pub use env::{EnvOptions, EnvReport, inspect_env};
pub use error::Error;
pub use executor::{ExecuteOptions, ExecutionReport, Executor};
pub use init::{InitKind, InitOptions, InitReport, init};
pub use manual::{
    FileOperationAction, FileOperationCompletionOptions, FileOperationOptions, FileOperationReport,
    ManualFileOperationOptions, file_operation_source_candidates, run_file_operation,
};
pub use metadata::{
    SPEC_VERSION, TREEBOOT_PACKAGE, TREEBOOT_VERSION, VersionInfo, config_schema_json,
    treeboot_version_info, treeboot_version_summary, version_info,
};
pub use output::{FileOperationSummary, OutputEvent, Reporter};
pub use run::{RunAction, RunOptions, RunReport, run};
pub use runtime::{ResolvedRuntimePolicy, RuntimeOptionOverrides, RuntimePolicy};
pub use status::{
    InitScriptStatus, StatusOptions, StatusReport, StatusSnapshotReport, inspect_status,
    inspect_status_snapshot,
};
pub use validation::{
    ActionPlan, ActionPlanOptions, PlanOrigin, PlanWarning, PlannedCommand, PlannedFileOperation,
    PlannedFileStatus,
};

/// Convenient result type used by `treeboot-core`.
pub type Result<T> = std::result::Result<T, Error>;
pub use config::{
    CommandKind, CommandOperation, Config, ConfigOptions, ConfigReport, ConfigRuntimeOptions,
    FileOperation, FileOperationKind, LoadedConfig, MetadataField, SourceSpan, SymlinkMode,
    SyncCompare, inspect_config,
};

/// Parsed treeboot manifest.
pub type Manifest = Config;

/// Options for inspecting a treeboot manifest.
pub type ManifestOptions = ConfigOptions;

/// Result summary for manifest inspection.
pub type ManifestReport = LoadedConfig;

/// Raw file operation intent used to build an action plan.
pub type FileOperationSpec = FileOperation;

/// Raw command intent used to build an action plan.
pub type CommandSpec = CommandOperation;