-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
dca3cc6
commit 5ab956d
Showing
1 changed file
with
1 addition
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,51 +1 @@ | ||
|
||
## Introduction | ||
|
||
A C++20 library offering a clean and simple interface to the miniz library for creating, reading, and updating ZIP files. | ||
|
||
## Examples | ||
|
||
```cpp | ||
#include <iostream> | ||
#include "zip.hpp" | ||
#include "exceptions.hpp" | ||
|
||
int main() | ||
{ | ||
try | ||
{ | ||
minidocx::Zip z; | ||
|
||
// Create a new zip archive. | ||
z.open("foo.zip", minidocx::Zip::OpenMode::Create); | ||
z.addFileFromString("a.txt", "aaa"); | ||
z.addFileFromString("dir/b.txt", "bbb"); | ||
z.addFileFromString("dir/subdir/c.txt", "ccc"); | ||
z.addFileFromString("dir/subdir/d.txt", "ddd"); | ||
z.close(); | ||
|
||
// Read the existing zip archive. | ||
z.open("foo.zip", minidocx::Zip::OpenMode::ReadOnly); | ||
std::cout << z.extractFileToString("a.txt") << std::endl; | ||
z.extractFileToDisk("dir/b.txt", "b.txt"); | ||
z.close(); | ||
|
||
// Update the existing zip archive. | ||
z.open("foo.zip", minidocx::Zip::OpenMode::Update); | ||
z.deleteFiles({ "a.txt", "dir/subdir/c.txt" }); | ||
z.addFileFromDisk("readme.md", "README.md"); | ||
z.close(); | ||
} | ||
catch (const minidocx::exception& ex) | ||
{ | ||
std::cerr << ex.what() << std::endl; | ||
} | ||
|
||
return 0; | ||
} | ||
``` | ||
|
||
Note: | ||
|
||
- No need to add directories manually unless you really want to add an empty directory. In this case, call the `create_directory()` method with an directory name ending in a forwardslash `/`. | ||
- If you delete a directory, it will also delete all files and directories in that directory. | ||
Vendored version of [totravel/zip](https://github.com/totravel/zip). |