Struct ZipTasklet 

pub struct ZipTasklet { /* private fields */ }

Available on crate feature zip only.

A tasklet for creating ZIP archives from files and directories.

This tasklet provides functionality similar to Spring Batch’s file compression capabilities, allowing you to compress files and directories into ZIP archives as part of a batch processing step.

Examples

use spring_batch_rs::core::step::{StepExecution, RepeatStatus, Tasklet};
use spring_batch_rs::tasklet::zip::ZipTaskletBuilder;
use spring_batch_rs::BatchError;
use std::path::Path;
use std::fs;
use std::env::temp_dir;

// Create test data directory and file
let temp_source_dir = temp_dir().join("test_source");
fs::create_dir_all(&temp_source_dir).unwrap();
fs::write(temp_source_dir.join("test.txt"), "test content").unwrap();

let archive_path = temp_dir().join("test_archive.zip");

let tasklet = ZipTaskletBuilder::new()
    .source_path(&temp_source_dir)
    .target_path(&archive_path)
    .build()?;

let step_execution = StepExecution::new("zip-step");
let result = tasklet.execute(&step_execution)?;
assert_eq!(result, RepeatStatus::Finished);

// Cleanup test files
fs::remove_file(&archive_path).ok();
fs::remove_dir_all(&temp_source_dir).ok();

Implementations

impl ZipTasklet

pub fn source_path<P: AsRef<Path>>(self, path: P) -> Self

Sets the source path to compress.

This is a required parameter that must be set before using the tasklet.

Parameters

• path: Path to the file or directory to compress

Returns

The updated ZipTasklet instance.

Examples

use spring_batch_rs::tasklet::zip::ZipTasklet;
use std::path::Path;
use std::fs;
use std::env::temp_dir;

let temp_data_dir = temp_dir().join("test_data");
fs::create_dir_all(&temp_data_dir).unwrap();

let tasklet = ZipTasklet::new()
    .source_path(&temp_data_dir);

fs::remove_dir_all(&temp_data_dir).ok();

pub fn target_path<P: AsRef<Path>>(self, path: P) -> Result<Self, BatchError>

Sets the target ZIP file path.

This is a required parameter that must be set before using the tasklet.

Parameters

• path: Path where the ZIP file will be created

Returns

The updated ZipTasklet instance, or an error if path validation fails.

Errors

• Returns error if source path doesn’t exist (when source_path has been set)
• Returns error if target directory cannot be created

Examples

use spring_batch_rs::tasklet::zip::ZipTasklet;
use std::path::Path;
use std::fs;
use std::env::temp_dir;

let temp_data_dir = temp_dir().join("test_data");
fs::create_dir_all(&temp_data_dir).unwrap();
let backup_path = temp_dir().join("backup.zip");

let tasklet = ZipTasklet::new()
    .source_path(&temp_data_dir)
    .target_path(&backup_path)?;

fs::remove_dir_all(&temp_data_dir).ok();

pub fn compression_level(self, level: i32) -> Self

Sets the compression level for the ZIP archive.

Parameters

• level: Compression level (0-9, where 0 is no compression and 9 is maximum)

Returns

The updated ZipTasklet instance.

Examples

use spring_batch_rs::tasklet::zip::ZipTasklet;

let tasklet = ZipTasklet::new()
    .compression_level(9); // Maximum compression

pub fn include_pattern<S: Into<String>>(self, pattern: S) -> Self

Sets a pattern for files to include in the archive.

Parameters

• pattern: Glob pattern for files to include (e.g., “.txt”, “**/.log”)

Returns

The updated ZipTasklet instance.

Examples

use spring_batch_rs::tasklet::zip::ZipTasklet;

let tasklet = ZipTasklet::new()
    .include_pattern("*.log");

pub fn exclude_pattern<S: Into<String>>(self, pattern: S) -> Self

Sets a pattern for files to exclude from the archive.

Parameters

• pattern: Glob pattern for files to exclude (e.g., “*.tmp”, “/target/”)

Returns

The updated ZipTasklet instance.

Examples

use spring_batch_rs::tasklet::zip::ZipTasklet;

let tasklet = ZipTasklet::new()
    .exclude_pattern("target/**");

pub fn preserve_structure(self, preserve: bool) -> Self

Sets whether to preserve directory structure in the archive.

Parameters

• preserve: If true, maintains directory structure; if false, flattens all files

Returns

The updated ZipTasklet instance.

Examples

use spring_batch_rs::tasklet::zip::ZipTasklet;

let tasklet = ZipTasklet::new()
    .preserve_structure(false); // Flatten all files

pub fn set_compression_level(&mut self, level: i32)

Sets the compression level for the ZIP archive.

Parameters

• level: Compression level (0-9, where 0 is no compression and 9 is maximum)

Examples

use spring_batch_rs::tasklet::zip::ZipTasklet;
use std::path::Path;
use std::fs;
use std::env::temp_dir;

// Create test data directory
let temp_data_dir = temp_dir().join("test_data_compression");
fs::create_dir_all(&temp_data_dir).unwrap();
fs::write(temp_data_dir.join("test.txt"), "test content").unwrap();

let backup_path = temp_dir().join("backup_compression.zip");

let mut tasklet = ZipTasklet::new()
    .source_path(&temp_data_dir)
    .target_path(&backup_path)?;
tasklet.set_compression_level(9); // Maximum compression

// Cleanup test files
fs::remove_dir_all(&temp_data_dir).ok();

Trait Implementations

impl Tasklet for ZipTasklet

fn execute( &self, _step_execution: &StepExecution, ) -> Result<RepeatStatus, BatchError>

Executes the ZIP compression operation.

This method creates a ZIP archive from the configured source path, applying any specified filters and compression settings.

Parameters

• step_execution: The current step execution context

Returns

• Ok(RepeatStatus::Finished): Compression completed successfully
• Err(BatchError): Error during compression

Examples

use spring_batch_rs::core::step::{StepExecution, Tasklet};
use spring_batch_rs::tasklet::zip::ZipTasklet;
use std::path::Path;

let tasklet = ZipTasklet::new()
    .source_path(Path::new("./data"))
    .target_path(Path::new("./archive.zip"))?;

let step_execution = StepExecution::new("zip-step");
let result = tasklet.execute(&step_execution)?;