Native Zip

https://pub.dev/packages/native_zip
Admin
A Flutter FFI plugin for fast, easy-to-use, multi-threaded ZIP file operations, implemented in...
Tokens:8,830
Snippets:112
Trust Score:9.9
Update:1 year ago
Show doc for...
Tokens:
Raw
### Stopwatch for Timing Operations

Source: https://pub.dev/packages/native_zip/example

A custom Stopwatch class to measure the duration of operations. It records the start time and provides a step function to log the time elapsed since the last step.

```dart
class Stopwatch {
  int _now = 0;
  Stopwatch() {
    _now = DateTime.now().millisecondsSinceEpoch;
  }
  void step(String msg) {
    int start = _now;
    _now = DateTime.now().millisecondsSinceEpoch;
    int diff = _now - start;
    log("$msg -- time elapsed: $diff ms");
  }
}
```

--------------------------------

### Initialize and Run App

Source: https://pub.dev/packages/native_zip/example

The main function initializes the Flutter application by running the MyApp widget. It sets up the entry point for the application's UI and lifecycle.

```dart
void main() {
  runApp(const MyApp());
}
```

--------------------------------

### Get Entries from ZIP Archive

Source: https://pub.dev/packages/native_zip/example

Retrieves a list of entries from a ZIP archive. This function can optionally filter entries by a specific path within the archive. The ZIP file handle is implicitly closed upon completion.

```dart
void test_zip_get_entries() async {
    var zip = NativeZip.openZipFile("d:\\test\\zip\\flutter.zip");

    var entries = zip.getEntries(
      //path: "flutter/docs/contributing/",

```

--------------------------------

### Trigger ZIP Operations

Source: https://pub.dev/packages/native_zip/example

Handles button click events to trigger various ZIP file operations. It includes calls to rename entries, read large files, and potentially get entries from a ZIP archive.

```dart
void onTestButtonClick() async {
    try {
      //await test_zipDir(); // OK 2

      test_zip_entry_rename();
      test_zip_read_big();
      //test_zip_get_entries();
    } catch (e) {
      log("@@@@@@@@@@@@@@@@ exception: $e");
    }
  }
```

--------------------------------

### Example pubspec.yaml Entry

Source: https://pub.dev/packages/native_zip/versions/0.8.0/install

This shows how the native_zip dependency is declared in a project's pubspec.yaml file after running the add command.

```yaml
dependencies:
  native_zip: ^0.8.0
```

--------------------------------

### Flutter App State Management

Source: https://pub.dev/packages/native_zip/example

The MyApp widget is a StatefulWidget that manages the application's state. It includes an initState method to initialize operations and a reassemble method for hot-reloading scenarios.

```dart
class MyApp extends StatefulWidget {
  const MyApp({super.key});

  @override
  State<MyApp> createState() => _MyAppState();
}

class _MyAppState extends State<MyApp> {
  late Future<int> sumAsyncResult;

  @override
  void initState() {
    super.initState();
    test();
  }

  @override
  void reassemble() {
    super.reassemble();
    test();
  }
  // ... other methods
}
```

--------------------------------

### Get Entries from ZIP File with NativeZip in Dart

Source: https://pub.dev/packages/native_zip/versions/0.8.1/example

This function demonstrates how to retrieve a list of entries within a ZIP file, optionally filtering by a specific path, using the `getEntries` method. It requires opening the ZIP file first.

```dart
void test_zip_get_entries() async {
    var zip = NativeZip.openZipFile("d:\\test\\zip\\flutter.zip");

    var entries = zip.getEntries(
      //path: "flutter/docs/contributing/",
      path: "flutter",
    );
```

--------------------------------

### List Directory Entries with Native Zip

Source: https://pub.dev/packages/native_zip/example

This function demonstrates how to list entries in a directory using the native_zip package. It takes a path and a recursive flag as input and prints the count and details of each entry found. Dependencies include 'dart:io' and 'package:intl/intl.dart'.

```dart
Future<void> test_list() async {
    var entries = await NativeZip.listDir(path: "flutter", recursive: false);
    print("### count: ${entries.length}");
    for (var e in entries) {
      print("==> ${e.originalSize}, ${DateFormat("yyyy-MM-dd HH:mm:ss").format(e.modifiedDateTime)} , ${e.path}");
    }
  }
```

--------------------------------

### Main Test Function for ZIP Operations

Source: https://pub.dev/packages/native_zip/example

The primary test function that orchestrates various ZIP operations. It includes commented-out calls to different testing functions, allowing for selective execution of ZIP functionalities.

```dart
Future<void> test() async {
    try {
      //initDartLog();
      //test_ZipStream();
      //test_Zip();
      //test_zip_read();

      //await test_zipDir(); // OK 2
      //await test_unzipDir(); // OK 2

      //await test_zip_entry_rename(); // OK 2 // rename root dir 比 7-zip 耗時...
      //await test_zip_entry_move(); // OK 2
      //await test_zip_entry_remove(); // OK 2
    } catch (e) {
      log("@@@@@@@@@@@@@@@@ Exception: $e");
    }
  }
```

--------------------------------

### Install Development Packages on Ubuntu Linux

Source: https://pub.dev/packages/native_zip/index

Installs necessary development packages on Ubuntu Linux for working with zip-related tools. This includes `libzip-dev` for library support and utilities like `zipcmp`, `zipmerge`, and `ziptool`.

```Shell
sudo apt install libzip-dev
sudo apt install zipcmp
sudo apt install zipmerge
sudo apt install ziptool
```

--------------------------------

### GZIP Compression and Decompression with NativeZip

Source: https://pub.dev/packages/native_zip/versions/0.8.1/example

Demonstrates GZIP compression and decompression using the NativeZip library. It shows how to encode a string to UTF-8, compress it using NativeZip.gzip, decompress it using NativeZip.gunzip, and decode the result back to a string. It also includes file-based compression and decompression, piping data between file streams and the compression/decompression transformers.

```dart
import 'dart:convert';
import 'dart:developer';
import 'dart:io';

import 'package:native_zip/native_zip.dart';

Future<void> test_ZipStream() async {
    List<int> list = utf8.encode("333abcdefg");
    var cc = await Stream.value(list)
        .transform(NativeZip.gzip)
        .transform(NativeZip.gunzip)
        .expand((x) => x)
        .toList();
    var ss = utf8.decode(cc);
    log("ccc = $ss");
    if (true) return;

    var srcFile = "D:/license.txt";
    //var srcFile = "D:/novel.txt";
    var zipFile = "D:/zipped.txt";
    var unzipFile = "D:/unzipped.txt";

    var zipSink = File(zipFile).openWrite();
    await File(srcFile).openRead().transform(NativeZip.gzip).pipe(zipSink);
    await zipSink.close();

    var unzipSink = File(unzipFile).openWrite();
    await File(zipFile).openRead().transform(NativeZip.gunzip).pipe(unzipSink);
    await unzipSink.close();
  }
```

--------------------------------

### Install libzip on macOS

Source: https://pub.dev/packages/native_zip/index

Installs the libzip library on macOS using the Homebrew package manager. This is a prerequisite for development tasks involving the native_zip plugin on macOS.

```Shell
brew install libzip
```

--------------------------------

### Extracting Files from a ZIP Archive

Source: https://pub.dev/packages/native_zip/versions/0.8.3/score

This example shows how to extract the contents of a ZIP archive using the `native_zip` package. It utilizes the `inflate` method, specifying the input ZIP file path and the directory where the contents should be extracted. Proper error handling should be implemented.

```dart
import 'package:native_zip/native_zip.dart';

Future<void> extractZipArchive(String zipFilePath, String outputDirectory) async {
  final nativeZip = NativeZip();
  try {
    await nativeZip.inflate(input: zipFilePath, output: outputDirectory);
    print('ZIP archive extracted successfully to: $outputDirectory');
  } catch (e) {
    print('Error extracting ZIP archive: $e');
  }
}
```

--------------------------------

### Add native_zip Dependency for Dart

Source: https://pub.dev/packages/native_zip/versions/0.8.1/install

This command adds the native_zip package as a dependency to your Dart project. It modifies your pubspec.yaml file and runs `dart pub get` to fetch the package.

```bash
$ dart pub add native_zip
```

--------------------------------

### Gzip and Gunzip Data Stream in Dart

Source: https://pub.dev/packages/native_zip/versions/0.8.2/example

Illustrates compressing and decompressing data from a file stream using NativeZip's gzip and gunzip transforms. This example reads from a source file, pipes it through gzip (commented out), and then pipes a gzipped file through gunzip to an output file, measuring the time taken.

```dart
var srcFile = "D:/test/zip/flutter-gnu.tar";
var zipFile = "D:/test/zip/___zip___flutter-gnu.tar";
var unzipFile = "D:/test/zip/___unzip___flutter-gnu.tar";

var sw = Stopwatch();
log("stream zip start");
//var zipSink = File(zipFile).openWrite();
//await File(srcFile).openRead().transform(NativeZip.gzip).pipe(zipSink);
//await zipSink.close();
//sw.step("stream zip finish");

var unzipSink = File(unzipFile).openWrite();
await File(zipFile).openRead().transform(NativeZip.gunzip).pipe(unzipSink);
await unzipSink.close();
sw.step("stream unzip finish");
```

--------------------------------

### Stream Zip and Unzip Operations with Native Zip (Dart)

Source: https://pub.dev/packages/native_zip/versions/0.8.3/example

Illustrates streaming compression and decompression using NativeZip.gzip and NativeZip.gunzip. This example shows encoding a string to bytes, streaming it through gzip and gunzip, and then decoding the result. It also includes file-based zip and unzip operations, piping data between file streams and the compression transformers. Dependencies include `dart:convert` for encoding/decoding and `dart:io` for file operations.

```dart
Future<void> test_ZipStream() async {
    List<int> list = utf8.encode("333abcdefg");
    var cc = await Stream.value(list)
        .transform(NativeZip.gzip)
        .transform(NativeZip.gunzip)
        .expand((x) => x)
        .toList();
    var ss = utf8.decode(cc);
    log("ccc = $ss");
    if (true) return;

    var srcFile = "D:/license.txt";
    //var srcFile = "D:/novel.txt";
    var zipFile = "D:/zipped.txt";
    var unzipFile = "D:/unzipped.txt";

    var zipSink = File(zipFile).openWrite();
    await File(srcFile).openRead().transform(NativeZip.gzip).pipe(zipSink);
    await zipSink.close();

    var unzipSink = File(unzipFile).openWrite();
    await File(zipFile).openRead().transform(NativeZip.gunzip).pipe(unzipSink);
    await unzipSink.close();
  }
```

--------------------------------

### Add native_zip Dependency for Flutter

Source: https://pub.dev/packages/native_zip/versions/0.8.1/install

This command adds the native_zip package as a dependency to your Flutter project. It modifies your pubspec.yaml file and runs `flutter pub get` to fetch the package.

```bash
$ flutter pub add native_zip
```

--------------------------------

### Install native_zip Dependency

Source: https://pub.dev/packages/native_zip/index

Adds the native_zip package as a dependency to your Flutter project by including it in the `pubspec.yaml` file. Ensure you are using a compatible version.

```YAML
dependencies:
  native_zip: latest
```

--------------------------------

### Flutter UI with Test Button

Source: https://pub.dev/packages/native_zip/versions/0.8.2/example

A basic Flutter widget that displays a CircularProgressIndicator and a button to trigger a test function. This UI is part of the example demonstrating the native_zip package functionalities.

```dart
 @override
  Widget build(BuildContext context) {
    Widget body = Column(
      mainAxisSize: MainAxisSize.min,
      children: [
        CircularProgressIndicator(),
        SizedBox.square(dimension: 30),
        ElevatedButton(onPressed: onTestButtonClick, child: Text("Test")),
      ],
    );

    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('Native Packages')),
        body: Center(child: body),
      ),
    );
  }
```

--------------------------------

### Get List of Entries in ZIP File using NativeZip

Source: https://pub.dev/packages/native_zip/versions/0.8.2/example

This function shows how to retrieve a list of all entries (files and directories) contained within a ZIP archive using the NativeZip plugin. After opening the ZIP file, the getEntries() method is called to obtain this information. Note: The actual retrieval logic is not shown in this snippet, only the initialization.

```dart
void test_zip_get_entries() async {
    var zip = NativeZip.openZipFile("d:\\test\\zip\\flutter.zip");


```

--------------------------------

### Get Entries from ZIP with NativeZip Flutter

Source: https://pub.dev/packages/native_zip/versions/0.8.0/example

Retrieves a list of entries from a ZIP file, optionally filtered by a path prefix, using the native_zip plugin. This function helps in inspecting the contents of a ZIP archive.

```dart
void test_zip_get_entries() async {
    var zip = NativeZip.openZipFile("d:\\test\\zip\\flutter.zip");

    var entries = zip.getEntries(
      //path: "flutter/docs/contributing/",
      path: "flutter",
    );
  }
```

--------------------------------

### Get Entries from Zip File

Source: https://pub.dev/packages/native_zip/versions/0

Retrieves entries (files and directories) from a zip file. Can fetch all entries, or filter by a specific path and recursion behavior. Directory paths must end with '/'.

```dart
var entries = zip.getEntries();

```

```dart
var entries = zip.getEntries(
  path: "flutter/",  // optional, default is "" (root)
  recursive: true, // optional, default is true
);

```

```dart
var entries = zip.getEntries(
  path: "flutter/docs/",  // optional, default is "" (root)
  recursive: false, // optional, default is true
);

```

--------------------------------

### Get Zip Entries in Dart

Source: https://pub.dev/packages/native_zip/versions/0.8.2/example

Retrieves entries from a ZIP archive. It takes a path within the archive and a recursive flag as input. It returns a list of entries and prints the count and details of each entry.

```dart
var entries = zip.getEntries(
  //path: "flutter/docs/contributing/",
  path: "flutter",
  recursive: false,
);
print("### count: ${entries.length}");
for (var e in entries) {
  print(
    "==> ${e.originalSize}, ${DateFormat("yyyy-MM-dd HH:mm:ss").format(e.modifiedDateTime)} , ${e.path}",
  );
}
```

--------------------------------

### Read File Content from Zip Archive

Source: https://pub.dev/packages/native_zip/versions/0

Opens a file within the zip archive for reading its content as a stream of bytes. An example demonstrates reading a text file, decoding it using UTF-8, and printing its content.

```dart
Stream<List<int>> content = zip.openRead("docs/README.md");

```

```dart
String content = await zip
    .openRead("docs/README.md")
    .transform(utf8.decoder)
    .join();
print(content);

```

--------------------------------

### Get List of Entries in a ZIP File

Source: https://pub.dev/packages/native_zip/versions/0.8.3/example

Demonstrates how to retrieve a list of all entries within a ZIP archive using the native_zip package. This function allows filtering entries by a specific path prefix, enabling targeted retrieval of entry names. The result is a list of strings, where each string is a path to an entry within the ZIP file.

```dart
import 'package:native_zip/native_zip.dart';

Future<List<String>> getZipEntries(String zipPath, {String? pathPrefix}) async {
    var zip = NativeZip.openZipFile(zipPath);
    var entries = zip.getEntries(path: pathPrefix);
    return entries;
}
```

--------------------------------

### Basic ZIP Archive Creation

Source: https://pub.dev/packages/native_zip/versions/0.8.3/score

This snippet demonstrates how to create a new ZIP archive using the `native_zip` package. It involves creating an instance of `NativeZip` and then calling the `deflate` method with the desired output path and input files. Error handling might be necessary for production code.

```dart
import 'package:native_zip/native_zip.dart';

Future<void> createZipArchive(String outputPath, List<String> inputFiles) async {
  final nativeZip = NativeZip();
  try {
    await nativeZip.deflate(output: outputPath, input: inputFiles);
    print('ZIP archive created successfully at: $outputPath');
  } catch (e) {
    print('Error creating ZIP archive: $e');
  }
}
```

--------------------------------

### Create and Extract ZIP Archives with Progress

Source: https://pub.dev/packages/native_zip/versions/0.8.3/example

Shows how to create a ZIP archive from a directory and extract a ZIP archive to a directory using the native_zip package. It includes progress reporting for both operations, allowing users to monitor the status and see which file is currently being processed. Password protection can also be applied during extraction.

```dart
import 'dart:async';
import 'dart:developer';
import 'package:native_zip/native_zip.dart';

void test_showProgress(ZipTaskFuture future) {
    var timer = Timer.periodic(const Duration(milliseconds: 500), (_) {
      var progress = future.processedSize / future.totalSize * 100;
      var compressRatio = future.compressedSize / future.processedSize * 100;
      var path = future.nowProcessingFilepath;
      log("progress: $progress%, compress ratio: $compressRatio%, path: $path");
    });
    future.whenComplete(() {
      log("================= finish ===================");
      timer.cancel();
    });
}

Future<void> zipDirectory(String dirPath, String zipPath) async {
    log("zipDir() start...");
    var future = NativeZip.zipDir(
      dirPath,
      zipPath,
      compressLevel: 5,
    );
    test_showProgress(future);
    await future;
    log("zipDir() finish");
}

Future<void> unzipDirectory(String zipPath, String dirPath, {String? password}) async {
    log("unzipDir() start...");
    var future = NativeZip.unzipToDir(zipPath, dirPath, password: password);
    test_showProgress(future);
    await future;
    log("unzipDir() finish");
}
```

--------------------------------

### Read ZIP Entry Content and Write to File

Source: https://pub.dev/packages/native_zip/versions/0.8.3/example

Illustrates how to open a ZIP file, read the content of a specific entry, and pipe it to a file sink. This is useful for extracting individual files from an archive. It demonstrates reading a file entry and writing its raw bytes to a temporary output file, ensuring the ZIP file is closed afterward.

```dart
import 'dart:io';
import 'package:native_zip/native_zip.dart';

Future<void> readAndWriteZipEntry(String zipPath, String entryName, String outFilePath) async {
    var zip = NativeZip.openZipFile(zipPath);
    var fileSink = File(outFilePath).openWrite();
    await zip
        .openRead(entryName)
        .pipe(fileSink);
    await fileSink.close();
    zip.close();
    log("readAndWriteZipEntry() finish");
}
```

--------------------------------

### Creating a ZIP Archive with Compression Level

Source: https://pub.dev/packages/native_zip/versions/0.8.3/score

This snippet illustrates how to create a ZIP archive with a specific compression level using the `native_zip` package. The `deflateWithLevel` method allows control over the compression ratio, balancing file size and creation time. The `level` parameter typically ranges from 0 (no compression) to 9 (maximum compression).

```dart
import 'package:native_zip/native_zip.dart';

Future<void> createZipArchiveWithLevel(String outputPath, List<String> inputFiles, int compressionLevel) async {
  final nativeZip = NativeZip();
  try {
    await nativeZip.deflateWithLevel(output: outputPath, input: inputFiles, level: compressionLevel);
    print('ZIP archive created successfully with level $compressionLevel at: $outputPath');
  } catch (e) {
    print('Error creating ZIP archive with level: $e');
  }
}
```

--------------------------------

### List Directory Entries with Native Zip (Dart)

Source: https://pub.dev/packages/native_zip/versions/0.8.3/example

Demonstrates how to list entries in a directory using the native_zip package. It recursively scans the 'flutter' directory and prints the count and details of each entry, including original size, modification date, and path. No external dependencies are required beyond the package itself.

```dart
Future<void> test_ZipEntries() async {
    var entries = await NativeZip.entries(
      path: "flutter",
      recursive: false,
    );
    print("### count: ${entries.length}");
    for (var e in entries) {
      print(
        "==> ${e.originalSize}, ${DateFormat("yyyy-MM-dd HH:mm:ss").format(e.modifiedDateTime)} , ${e.path}",
      );
    }
  }
```

--------------------------------

### Iterate and Print Zip Entry Information

Source: https://pub.dev/packages/native_zip/versions/0

Demonstrates how to iterate through zip entries and access their properties such as directory status, path, modification date, original size, and compressed size. It also shows how to open a file stream for reading.

```dart
for (var e in entries) {
  // e.isDirectory
  // e.path
  // e.modifiedDateTime
  // e.originalSize
  // e.compressedSize

  // Stream<List<int>> stream = e.openRead();
}

```

--------------------------------

### Basic ZIP File Operations with Native Zip

Source: https://pub.dev/packages/native_zip/versions/0.8.3/example

Demonstrates core functionalities of the native_zip package, including opening a ZIP file, reading its entries, and performing operations like renaming, moving, and removing entries. It requires a valid ZIP file path and specific entry paths for manipulation. The operations include renaming entries, moving multiple entries to a directory, and removing entries.

```dart
import 'package:native_zip/native_zip.dart';

Future<void> performZipOperations() async {
    var zipPath = "d:\\test\\zip\\flutter.zip";

    // Rename an entry
    var oldEntryPath = "notFound/";
    var newEntryPath = "flutter/kk中文/";
    await NativeZip.openZipFile(zipPath).renameEntry(oldEntryPath, newEntryPath);

    // Move multiple entries
    var entriesToMove = <String>["flutter/tt暫存/docs/", "flutter/tt暫存/README.md"];
    var toDirPath = "";
    await NativeZip.openZipFile(zipPath).moveEntries(entriesToMove, toDirPath);

    // Remove entries
    var entriesToRemove = <String>["README.md"];
    await NativeZip.openZipFile(zipPath).removeEntries(entriesToRemove);
}
```

--------------------------------

### Gzip and Gunzip Data Buffer in Dart

Source: https://pub.dev/packages/native_zip/versions/0.8.2/example

Demonstrates compressing and decompressing a byte buffer using NativeZip's gzip and gunzip transforms. It encodes a string to UTF-8, processes it through the transforms, decodes the result, and logs it.

```dart
List<int> list = utf8.encode("333abcdefg");
var cc = await Stream.value(list)
    .transform(NativeZip.gzip)
    .transform(NativeZip.gunzip)
    .expand((x) => x)
    .toList();
var ss = utf8.decode(cc);
log("ccc = $ss");
```

--------------------------------

### Build Android App Bundle with specific platform

Source: https://pub.dev/packages/native_zip/index

Generates an Android App Bundle (.aab) for uploading to Google Play. This command targets the `android-arm64` platform, optimizing the build for specific device architectures.

```Shell
flutter build appbundle --target-platform android-arm64
```

--------------------------------

### Progress Monitoring for ZIP Tasks in Flutter

Source: https://pub.dev/packages/native_zip/versions/0.8.0/example

A utility function to monitor the progress of ZIP operations (like zipping or unzipping) initiated by the native_zip plugin. It uses a Timer to periodically log the progress percentage, compression ratio, and the currently processing file path.

```dart
void test_showProgress(ZipTaskFuture future) {
    var timer = Timer.periodic(const Duration(milliseconds: 500), (_) {
      var progress = future.processedSize / future.totalSize * 100;
      var compressRatio = future.compressedSize / future.processedSize * 100;
      var path = future.nowProcessingFilepath;
      log("progress: $progress%, compress ratio: $compressRatio%, path: $path");
    });
    future.whenComplete(() {
      log("================= finish ===================");
      timer.cancel();
    });
  }
```

--------------------------------

### Build Android APK with specific platform

Source: https://pub.dev/packages/native_zip/index

Builds an Android APK file for the specified target platform, which is `android-arm64` in this case. This command is used to generate smaller APK files by targeting specific architectures.

```Shell
flutter build apk --target-platform android-arm64
```

--------------------------------

### Dart FFI Plugin for ZIP Operations (native_zip)

Source: https://pub.dev/packages/native_zip/score

This snippet showcases the core functionality of the native_zip Dart FFI plugin. It is designed for fast, easy-to-use, and multi-threaded ZIP file operations. The plugin relies on Dart's FFI to interact with native libraries, enabling efficient archive management. Dependencies include the 'ffi' package.

```dart
import 'dart:ffi';
import 'package:ffi/ffi.dart';

// Placeholder for native library loading and function signatures
// Actual implementation would involve DynamicLibrary.open and setup

class NativeZip {
  // Constants for compression types
  static const int _TYPE_GZIP = 31; // raw deflate, 16 + 8~15
  static const int _TYPE_ZLIB = 15; // zlib, 9~15

  // Example of a native method signature (actual signature depends on native implementation)
  // late DynamicLibrary _nativeLib;
  // late int Function(Pointer<Utf8>, Pointer<Utf8>) _zipFunction;

  // NativeZip() {
  //   // Load the native library
  //   _nativeLib = DynamicLibrary.open('native_zip.dll'); // Example for Windows
  //   // Look up the function
  //   _zipFunction = _nativeLib.lookupFunction<NativeZipZipFunc, ZipFunc>('zip_files');
  // }

  /// Creates a compressed archive from input files.
  ///
  /// Args:
  ///   inputPaths: A list of paths to the files to be compressed.
  ///   outputPath: The path for the output ZIP file.
  ///   level: The compression level (0-9).
  ///
  /// Returns:
  ///   True if compression was successful, false otherwise.
  bool deflate(List<String> inputPaths, String outputPath, {int level = 6}) {
    // Simulate native call
    print('Deflating files to $outputPath with level $level');
    // Real implementation would use FFI to call native code
    // final cInputPaths = inputPaths.map((p) => p.toNativeUtf8()).toList();
    // final cOutputPath = outputPath.toNativeUtf8();
    // final result = _zipFunction(cOutputPath, /* ... other args ... */);
    // // Clean up native memory
    // return result == 0;
    return true; // Placeholder
  }

  /// Creates a compressed archive with a specified compression level.
  ///
  /// Similar to `deflate` but explicitly allows setting the compression level.
  bool deflateWithLevel(List<String> inputPaths, String outputPath, int level) {
    return deflate(inputPaths, outputPath, level: level);
  }

  // Other ZIP operations like extract, list, etc. would be defined here.
}

// Example usage (requires actual native implementation to run)
// void main() {
//   final nativeZip = NativeZip();
//   final filesToZip = ['file1.txt', 'file2.txt'];
//   final zipFilePath = 'archive.zip';
//   
//   if (nativeZip.deflate(filesToZip, zipFilePath, level: 9)) {
//     print('ZIP archive created successfully!');
//   } else {
//     print('Failed to create ZIP archive.');
//   }
// }

```

--------------------------------

### Basic Flutter UI for Native Zip Testing (Dart)

Source: https://pub.dev/packages/native_zip/versions/0.8.3/example

A simple Flutter widget that displays a circular progress indicator and a 'Test' button. Pressing the button triggers the `onTestButtonClick` function (not shown in this snippet), presumably to initiate tests for the native_zip package. This widget is part of a MaterialApp for basic application structure.

```dart
@override
  Widget build(BuildContext context) {
    Widget body = Column(
      mainAxisSize: MainAxisSize.min,
      children: [
        CircularProgressIndicator(),
        SizedBox.square(dimension: 30),
        ElevatedButton(onPressed: onTestButtonClick, child: Text("Test")),
      ],
    );

    return MaterialApp(
      home: Scaffold(
        appBar: AppBar(title: const Text('Native Packages')),
        body: Center(child: body),
      ),
    );
  }
```

--------------------------------

### Zip Directory with NativeZip Flutter

Source: https://pub.dev/packages/native_zip/versions/0.8.0/example

Compresses a specified directory into a ZIP file using the native_zip plugin. It allows setting the compression level and optionally a password. The operation returns a ZipTaskFuture which can be used to monitor progress.

```dart
Future<void> test_zipDir() async {
    var dirPath = "c:\\flutter";
    var zipPath = "d:\\test\\zip\\flutter.zip";
    log("zipDir() start...");
    var future = NativeZip.zipDir(
      dirPath,
      zipPath,
      compressLevel: 5,
      //password: "12345678",
    );
    test_showProgress(future);
    await future;
    _sw.step("zipDir() finish");
  }
```

--------------------------------

### Extract Files and Directories from Zip Archive to Disk

Source: https://pub.dev/packages/native_zip/index

Extracts specified files and directories from a zip archive to a target directory on the local disk. Supports multi-threading for faster extraction. Progress can be monitored via a Future.

```dart
var sourcesInZip = <String>["flutter/docs/", "flutter/README.md"];
var future = zip.saveFilesTo(
  sourcesInZip, 
  "D:\\dir",
  threadCount: threadCount, // optional
);

showProgress(future); // to show progress, mentioned above
await future;

```

--------------------------------

### Unzip Directory with NativeZip Flutter

Source: https://pub.dev/packages/native_zip/versions/0.8.0/example

Extracts the contents of a ZIP file to a specified directory using the native_zip plugin. It supports password-protected archives and provides a ZipTaskFuture for progress monitoring.

```dart
Future<void> test_unzipDir() async {
    var zipPath = "d:\\test\\zip\\flutter.zip";
    var dirPath = "d:\\test\\zip\\flutter_unzip";
    log("unzipDir() start...");
    var future = NativeZip.unzipToDir(zipPath, dirPath, password: "12345678");
    test_showProgress(future);
    await future;
    _sw.step("unzipDir() finish");
  }
```

--------------------------------

### Add Files and Directories from Disk to Zip Archive

Source: https://pub.dev/packages/native_zip/index

Adds files and directories from the local disk into an existing zip archive at a specified location within the archive. Supports optional compression level, skipping top-level directories, and multi-threading. Progress can be monitored via a Future.

```dart
var sourcesInDisk = <String>["D:\\dirA", "C:\\fileB.txt"];
var future = zip.addFiles(
  sourcesInDisk, 
  "targetDirInZip/",
  compressLevel: compressLevel, // optional
  skipTopLevel: skipTopLevel,   // optional
  threadCount: threadCount      // optional
);

showProgress(future); // to show progress, mentioned above
await future;

```

--------------------------------

### Compress Folder to ZIP using native_zip

Source: https://pub.dev/packages/native_zip/versions/0

Compresses a specified directory into a ZIP archive. Supports optional password protection, compression level, and multi-threading for faster processing. Progress can be displayed using a `showProgress` function.

```dart
var future = NativeZip.zipDir(
  "D:\\folder_path",
  "D:\\test.zip",
  password: "your-password",    // optional
  compressLevel: 5,  // optional
  threadCount: 8,    // optional
);
await future;
```

--------------------------------

### Extract ZIP Archive to Directory using native_zip

Source: https://pub.dev/packages/native_zip/versions/0

Extracts all files from a specified ZIP archive to a target directory. Supports optional password protection for encrypted archives and multi-threading for faster extraction. Progress can be displayed using the `showProgress` function.

```dart
var future = NativeZip.unzipToDir(
  "D:\\test.zip", 
  "D:\\output_folder", 
  password: "password-of-zip",  // optional
  threadCount: 8,               // optional
);

showProgress(future); // to show progress, mentioned above
await future;
```

--------------------------------

### Count Zip Entries with NativeZip

Source: https://pub.dev/packages/native_zip/versions/0.8.0/example

This function demonstrates how to count the number of entries within a ZIP archive using the `NativeZip.zipEntries` method. It iterates through the entries and prints their original size, modification date, and path. Requires the `native_zip` package.

```dart
Future<void> test_ZipEntries() async {
    var entries = await NativeZip.zipEntries(
      "D:/archive.zip",
      recursive: false,
    );
    print("### count: ${entries.length}");
    for (var e in entries) {
      print(
        "==> ${e.originalSize}, ${DateFormat("yyyy-MM-dd HH:mm:ss").format(e.modifiedDateTime)} , ${e.path}",
      );
    }
  }
```

--------------------------------

### Read Entry Content from ZIP with NativeZip Flutter

Source: https://pub.dev/packages/native_zip/versions/0.8.0/example

Opens and reads the content of a specific entry within a ZIP file using the native_zip plugin. The content is decoded as UTF-8. This function is suitable for text-based files.

```dart
Future<void> test_zip_read() async {
    var zip = NativeZip.openZipFile("d:\\test\\zip\\flutter.zip");

    var content = await zip
        //.openRead("flutter/kk中文/LICENSE")
        .openRead("flutter/docs/README.md")
        .transform(utf8.decoder)
        .join();
    print(content);
  }
```

--------------------------------

### Read Large Entry to File with NativeZip Flutter

Source: https://pub.dev/packages/native_zip/versions/0.8.0/example

Reads a large entry from a ZIP file and pipes its content directly to a file sink using the native_zip plugin. This method is efficient for handling large binary files without loading the entire content into memory.

```dart
Future<void> test_zip_read_big() async {
    var outFile = "d:\\test\\zip\\out.tmp";
    var zip = NativeZip.openZipFile("d:\\test\\zip\\flutter.zip");

    var fileSink = File(outFile).openWrite();
    await zip
        .openRead(
          "flutter/bin/cache/artifacts/engine/windows-x64/flutter_windows.dll.pdb",
        )
        .pipe(fileSink);
    await fileSink.close();
    zip.close();
    log("test_zip_read_big() finish");
  }
```

--------------------------------

### Move Multiple Entries within Zip Archive

Source: https://pub.dev/packages/native_zip/index

Moves one or more files or directories to a specified destination path within the zip archive. Directory paths must end with a '/'. An empty string for the destination path refers to the root.

```dart
var entries = <String>["flutter/DirA/", "flutter/docs/DirB/", "prefix/fileA.txt"];
var toDirPath = "targetDirPath/";
await zip.moveEntries(entries, toDirPath);

```

--------------------------------

### Move Entries in ZIP with NativeZip Flutter

Source: https://pub.dev/packages/native_zip/versions/0.8.0/example

Moves multiple entries (files or directories) to a specified directory within an existing ZIP file using the native_zip plugin. This function operates on an opened ZipFile object.

```dart
Future<void> test_zip_entry_move() async {
    var zipPath = "d:\\test\\zip\\flutter.zip";
    var entries = <String>["flutter/tt暫存/docs/", "flutter/tt暫存/README.md"];
    var toDirPath = "";
    await NativeZip.openZipFile(zipPath).moveEntries(entries, toDirPath);
    _sw.step("moveEntries() finish");
  }
```

--------------------------------

### Open Zip File with NativeZip

Source: https://pub.dev/packages/native_zip/versions/0

Opens a zip file using NativeZip. Supports optional password protection for both existing and newly created zip files. If the zip file is password-protected, the correct password must be provided; otherwise, the operation will fail.

```dart
ZipFile zip = NativeZip.openZipFile(
  "D:\\test.zip", 
  password: "password", // optional
);

```

--------------------------------

### Move Entries to a Target Directory in Zip Archive

Source: https://pub.dev/packages/native_zip/versions/0

Moves one or more files or directories to a specified target directory within the zip archive. Directory paths must end with '/'. An empty string for the target path indicates the root directory.

```dart
var entries = <String>["flutter/DirA/", "flutter/docs/DirB/", "prefix/fileA.txt"];
var toDirPath = "targetDirPath/";
await zip.moveEntries(entries, toDirPath);

```

```dart
await zip.moveEntry("flutter/DirA/", "targetDirPath/");

```

--------------------------------

### Extract Files/Directories from Zip Archive to Disk

Source: https://pub.dev/packages/native_zip/versions/0

Extracts specified files or directories from a zip archive to a location on the local disk. Supports multi-threaded extraction for improved performance. The operation returns a future for progress monitoring and cancellation. Individual files/directories can be extracted using `zip.saveTo()`.

```dart
var sourcesInZip = <String>["flutter/docs/", "flutter/README.md"];
var future = zip.saveFilesTo(
  sourcesInZip, 
  "D:\\dir",
  threadCount: threadCount, // optional
);

showProgress(future); // to show progress, mentioned above
await future;

```

```dart
future.cancel();

```

--------------------------------

### Display Compression/Extraction Progress with native_zip

Source: https://pub.dev/packages/native_zip/versions/0

A utility function to display the progress of ZIP operations (compression or extraction) performed by the native_zip package. It uses a Timer to periodically log the processed size, compression ratio, and the file currently being processed.

```dart
void showProgress(ZipTaskFuture future) {
  var timer = Timer.periodic(const Duration(milliseconds: 500), (_) {
    var progress = future.processedSize / future.totalSize * 100;
    var compressRatio = future.compressedSize / future.processedSize * 100;
    var path = future.nowProcessingFilepath;
    log("progress: $progress%, compress ratio: $compressRatio%, path: $path");
  });
  future.whenComplete(() {
    log("finish");
    timer.cancel();
  });
}
```

--------------------------------

### Add Files/Directories from Disk to Zip Archive

Source: https://pub.dev/packages/native_zip/versions/0

Adds files or directories from the local disk into an existing zip archive. Supports specifying a target directory within the zip, compression level, skipping top-level directories, and using multiple threads for performance. The operation returns a future that can be used to monitor progress or cancel the operation.

```dart
var sourcesInDisk = <String>["D:\\dirA", "C:\\fileB.txt"];
var future = zip.addFiles(
  sourcesInDisk, 
  "targetDirInZip/",
  compressLevel: compressLevel, // optional
  skipTopLevel: skipTopLevel,   // optional
  threadCount: threadCount      // optional
);

showProgress(future); // to show progress, mentioned above
await future;

```

```dart
future.cancel();

```

--------------------------------

### Add native_zip Dependency to Flutter Project

Source: https://pub.dev/packages/native_zip/install

This command adds the native_zip package as a dependency to your Flutter project's pubspec.yaml file. It ensures the package is downloaded and available for use in your Dart code.

```shell
flutter pub add native_zip
```

--------------------------------

### Move Single Entry within Zip Archive

Source: https://pub.dev/packages/native_zip/index

Moves a single file or directory to a new location within the zip archive. This is a convenient method for relocating individual items.

```dart
await zip.moveEntry("flutter/DirA/", "targetDirPath/");

```

--------------------------------

### Remove Entries from ZIP with NativeZip Flutter

Source: https://pub.dev/packages/native_zip/versions/0.8.0/example

Removes one or more entries (files or directories) from an existing ZIP file using the native_zip plugin. The operation is performed on an opened ZipFile object.

```dart
Future<void> test_zip_entry_remove() async {
    var zipPath = "d:\\test\\zip\\flutter.zip";
    var entries = <String>["README.md"];
    await NativeZip.openZipFile(zipPath).removeEntries(entries);
    _sw.step("removeEntries() finish");
  }
```

--------------------------------

### Rename File or Directory in Zip Archive

Source: https://pub.dev/packages/native_zip/versions/0

Renames an existing entry (file or directory) within the zip archive. The `renameEntry` method takes the old path and the new path as arguments. Directory paths should end with '/'.

```dart
await zip.renameEntry("prefix/dirA/", "prefix/dirB/");

```

```dart
await zip.renameEntry("prefix/fileA.txt", "prefix/fileB.txt");

```

--------------------------------

### Extract Single File or Directory from Zip Archive

Source: https://pub.dev/packages/native_zip/index

Extracts a single file or directory from the zip archive to a specified location on the local disk. This is a convenience method for extracting individual items.

```dart
Use zip.saveTo() instead to copy only ONE directory or file.
Refer to `NativeZip.unzipToDir()` mentioned above for details.

```

--------------------------------

### Import native_zip Package in Dart Code

Source: https://pub.dev/packages/native_zip/install

This import statement allows you to access the functionalities provided by the native_zip package within your Dart or Flutter application. Ensure this is at the top of your Dart file.

```dart
import 'package:native_zip/native_zip.dart';
```

--------------------------------

### Rename Entry in ZIP with NativeZip Flutter

Source: https://pub.dev/packages/native_zip/versions/0.8.0/example

Renames a specific entry (file or directory) within an existing ZIP file using the native_zip plugin. This operation is performed on an opened ZipFile object.

```dart
Future<void> test_zip_entry_rename() async {
    var zipPath = "d:\\test\\zip\\flutter.zip";
    var oldEntryPath = "notFound/";
    var newEntryPath = "flutter/kk中文/";
    await NativeZip.openZipFile(
      zipPath,
    ).renameEntry(oldEntryPath, newEntryPath);
    _sw.step("renameEntry() finish");
  }
```

--------------------------------

### Close Zip File to Free Resources

Source: https://pub.dev/packages/native_zip/versions/0

Closes an opened zip file to release associated resources. This is a crucial step to ensure proper cleanup after performing operations on the zip archive.

```dart
zip.close();

```

--------------------------------

### Delete Multiple Entries from Zip Archive

Source: https://pub.dev/packages/native_zip/index

Removes multiple files or directories from the zip archive. This operation is useful for cleaning up archive contents.

```dart
var entries = <String>["flutter/docs/", "README.md"];
await zip.removeEntries(entries);

```

--------------------------------

### Delete Single Entry from Zip Archive

Source: https://pub.dev/packages/native_zip/index

Removes a single file or directory from the zip archive. This method is efficient for deleting specific items.

```dart
await zip.removeEntry("flutter/docs/");

```

--------------------------------

### Cancel Zip Archive Operation

Source: https://pub.dev/packages/native_zip/index

Allows canceling an ongoing asynchronous operation related to zip file manipulation, such as adding or extracting files. This is managed through a Future object.

```dart
future.cancel();

```

--------------------------------

### Delete Entries from Zip Archive

Source: https://pub.dev/packages/native_zip/versions/0

Removes one or more files or directories from the zip archive. The `removeEntries` method accepts a list of paths to be deleted. `removeEntry` can be used to delete a single entry.

```dart
var entries = <String>["flutter/docs/", "README.md"];
await zip.removeEntries(entries);

```

```dart
await zip.removeEntry("flutter/docs/");

```

--------------------------------

### Cancel ZIP Operation with native_zip

Source: https://pub.dev/packages/native_zip/versions/0

Demonstrates how to cancel an ongoing ZIP operation (compression or extraction) initiated by the native_zip package before it completes. This is achieved by calling the `cancel()` method on the returned `ZipTaskFuture` object.

```dart
future.cancel();
```
Tokens:
Raw