worktree_setup_operations 0.3.0

File operations for worktree-setup
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

//! File operations for worktree-setup.
//!
//! This crate provides file system operations for setting up worktrees:
//!
//! * Symlink creation
//! * File and directory copying
//! * Configuration application
//! * Operation planning with file counts
//!
//! # Example
//!
//! ```rust,ignore
//! use worktree_setup_operations::{plan_operations, execute_operation};
//!
//! // Plan operations first (for progress display)
//! let operations = plan_operations(&config, &main_path, &target_path, &options)?;
//!
//! // Execute each operation with progress callback
//! for op in &operations {
//!     execute_operation(op, |completed, total| {
//!         println!("{}/{} files", completed, total);
//!     })?;
//! }
//! ```

#![cfg_attr(feature = "fail-on-warnings", deny(warnings))]
#![warn(clippy::all, clippy::pedantic, clippy::nursery, clippy::cargo)]
#![allow(clippy::multiple_crate_versions)]

mod apply;
mod copy;
mod error;
mod plan;
mod symlink;

pub use apply::{
    ApplyConfigOptions, ApplyResult, OperationRecord, apply_config, execute_operation,
};
pub use copy::{
    copy_directory, copy_directory_with_progress, copy_file, copy_file_with_progress,
    overwrite_file, overwrite_file_with_progress,
};
pub use error::OperationError;
pub use plan::{
    OperationType, PlannedOperation, plan_operations, plan_operations_with_progress,
    plan_unstaged_operations,
};
pub use symlink::{create_symlink, force_create_symlink};
pub use worktree_setup_copy::CopyProgress;

/// Result of a single file operation.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum OperationResult {
    /// The operation created a new file/symlink.
    Created,
    /// The target already existed and was skipped.
    Exists,
    /// The source was not found and operation was skipped.
    Skipped,
    /// The target was overwritten.
    Overwritten,
}

impl std::fmt::Display for OperationResult {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::Created => write!(f, "created"),
            Self::Exists => write!(f, "exists"),
            Self::Skipped => write!(f, "skipped"),
            Self::Overwritten => write!(f, "overwritten"),
        }
    }
}