Interface WorkingCopy

atomic-core/src/output/traits.rs:314–397

Full read-write operations on the working copy. This trait extends `WorkingCopyRead` with methods for modifying the working copy: creating files, deleting files, renaming, etc. # Thread Safety Working copy operations are typically not thread-safe. Use appropriate synchronization if accessing from multiple threads.

/// Working copy operations are typically not thread-safe. Use appropriate
/// synchronization if accessing from multiple threads.
pub trait WorkingCopy: WorkingCopyRead {
    /// The writer type returned by `write_file`.
    type Writer: Write;

    /// Check if a path is writable.
    ///
    /// This can be used to skip files that should not be modified,
    /// such as those with special attributes or user-specified exclusions.
    ///
    /// # Arguments
    ///
    /// * `path` - Relative path within the working copy
    ///
    /// # Returns
    ///
    /// `true` if the file can be written, `false` if it should be skipped.
    fn is_writable(&self, _path: &str) -> Result<bool, Self::Error> {
        Ok(true)
    }

    /// Create a directory and all parent directories.
    ///
    /// # Arguments
    ///
    /// * `path` - Relative path of the directory to create
    ///
    /// # Returns
    ///
    /// `Ok(())` on success (including if the directory already exists).
    fn create_dir_all(&self, path: &str) -> Result<(), Self::Error>;

    /// Remove a file or directory.
    ///
    /// # Arguments
    ///
    /// * `path` - Relative path to remove
    /// * `recursive` - If true and path is a directory, remove contents recursively
    ///
    /// # Returns
    ///
    /// `Ok(())` on success. May return an error if the path doesn't exist
    /// or cannot be removed.
    fn remove_path(&self, path: &str, recursive: bool) -> Result<(), Self::Error>;

    /// Rename or move a file/directory.
    ///
    /// # Arguments
    ///
    /// * `from` - Current relative path
    /// * `to` - New relative path
    ///
    /// # Returns
    ///
    /// `Ok(())` on success. May return an error if the source doesn't exist
    /// or the destination cannot be written.
    fn rename(&self, from: &str, to: &str) -> Result<(), Self::Error>;

    /// Set file permissions.