https://github.com/hzeller/ziplain
A plain, no-frills ZIP file writer.
https://github.com/hzeller/ziplain
zip zipfile
Last synced: 3 months ago
JSON representation
A plain, no-frills ZIP file writer.
- Host: GitHub
- URL: https://github.com/hzeller/ziplain
- Owner: hzeller
- License: apache-2.0
- Created: 2022-08-27T20:53:29.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-26T16:30:05.000Z (about 1 year ago)
- Last Synced: 2024-06-17T00:18:48.804Z (11 months ago)
- Topics: zip, zipfile
- Language: C++
- Homepage:
- Size: 32.2 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ZIPlain
A plain, no-frills [ZIP-file] encoder with a simple [API](./ziplain.h).
Provides class `ziplain::Encoder` to create a ZIP file. Abstractions
for `ByteSource` and `ByteSink` allow to adapt it to local IO requirements.
## Build
There is a simple Makefile included for a standard build and test.
```
make test
```
(TODO: create a make install with pkg-config).
Also, for integration in bazel-based builds, a `MODULE.bazel` and `BUILD` is
included.
```
bazel build :ziplain
```
## Example use
In the following example, we provide the output `ByteSink` by implementing
a closure wrapping a `FILE*` stream.
As input `ByteSource`, ziplain-provided wrappers for files and in-memory
representations are used.
See [`demo.cc`](demo.cc) for full example.
```c++
constexpr int kCompressionLevel = 9;
FILE *out = fopen("test-output.zip", "wb");
ziplain::Encoder zipper(kCompressionLevel, [out](std::string_view s) {
return fwrite(s.data(), 1, s.size(), out) == s.size();
});
zipper.AddFile("ziplain.h", ziplain::FileByteSource("ziplain.h"));
zipper.AddFile("ziplain.cc", ziplain::FileByteSource("ziplain.cc"));
zipper.AddFile("readme.txt", ziplain::MemoryByteSource("Hello world!\n"));
zipper.Finish();
fclose(out);
```
[ZIP-file]: https://en.wikipedia.org/wiki/ZIP_(file_format)