Cancel ZIP archive creation

It may happen you want to cancel zip archive creation for various reasons. It just can take too long or you do not actually need some entries there.

Overview

There is an EventsBag class which are container for archive-related events. Now it supports one event - EntryCompressed. It raises after an archive entry has been compressed, and it cancelable.

Canceling long archive creation

Lets say you want your ZIP archive to be composed in about a minute. After some entry has been compressed check the time taken from the beginning of compression, and if it took more than a minute, cancel the process. The result archive would have already compressed entries including the one triggred the event.

Steps: To Canceling Long Archive Creation in C#

1. Initialize a new Archive object to handle the compression.
2. Start a stopwatch to track the duration of the compression process.
3. Create archive entries from a directory using the CreateEntries method, specifying the folder to compress.
4. Set up an EventsBag to handle compression events.
5. Attach an event handler for the EntryCompressed event, which checks if the elapsed time exceeds one minute and cancels the operation if necessary.
6. Start the stopwatch and proceed with saving the archive, passing the EventsBag in the ArchiveSaveOptions.

    using (var archive = new Archive())
    {
        Stopwatch sw = new Stopwatch();
                                
        archive.CreateEntries(@"D:\BigFolder");
        EventsBag eb = new EventsBag();
        eb.EntryCompressed += delegate(object sender, CancelEntryEventArgs args)
            {
            if (sw.Elapsed > TimeSpan.FromSeconds(60))
                args.Cancel = true;
            };
        sw.Start();
        archive.Save("output.zip", new ArchiveSaveOptions() { EventsBag = eb });
    }

Canceling after certain entry

If you want to cancel after particular entry has been compressed use following snippet:

Steps: canceling the archive creation after a specific entry is compressed in C#

1. Initialize a new Archive object to handle the compression.
2. Use the CreateEntries method to add files from a specified directory.
3. Set up an EventsBag to manage compression events.
4. Attach an event handler for the EntryCompressed event, which checks if the entry being compressed matches a specific file name (e.g., “last.bin”).
5. If the target entry is found, trigger the cancellation.
6. Save the archive with the EventsBag included in the ArchiveSaveOptions.

    using (var archive = new Archive())
    {                          
        archive.CreateEntries(@"D:\BigFolder");
        EventsBag eb = new EventsBag();
        eb.EntryCompressed += delegate(object sender, CancelEntryEventArgs args)
            {
            if (args.Entry.Name == @"BigFolder\last.bin")
                args.Cancel = true;
            };      
        archive.Save("output.zip", new ArchiveSaveOptions() { EventsBag = eb });
    }