Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/naqvis/snappy
Snappy compression format reader/writer for Crystal
https://github.com/naqvis/snappy
compression-format crystal crystal-lang crystal-language snappy
Last synced: 2 months ago
JSON representation
Snappy compression format reader/writer for Crystal
- Host: GitHub
- URL: https://github.com/naqvis/snappy
- Owner: naqvis
- License: mit
- Created: 2019-09-23T13:10:50.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2021-03-25T06:36:12.000Z (over 3 years ago)
- Last Synced: 2024-01-27T09:09:44.236Z (5 months ago)
- Topics: compression-format, crystal, crystal-lang, crystal-language, snappy
- Language: Crystal
- Size: 1.26 MB
- Stars: 17
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Lists
- awesome-crystal - snappy - Snappy compression format reader/writer for Crystal (Compression)
- awesome-crystal - snappy - Snappy compression format reader/writer for Crystal (Compression)
README
# Crystal Snappy
[](https://github.com/naqvis/snappy/releases)
[](https://naqvis.github.io/snappy/)
**Pure Crystal** implementation of [Snappy](https://github.com/google/snappy) compression format. This implementation supports more common case [Snappy Framing Format](https://github.com/google/snappy/blob/master/framing_format.txt).
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
snappy:
github: naqvis/snappy
```
2. Run `shards install`
## Usage
```crystal
require "snappy"
```
Module provides both `Compress::Snappy::Reader` and `Compress::Snappy::Writer` for use with streams like `IO` and/or files. It also provides `Compress::Snappy#decode` and `Compress::Snappy#encode` for uncompressing and compressing block formats.
## Example: decompress a snappy file
#
```crystal
require "snappy"
File.write("file.sz", Bytes[255, 6, 0, 0, 115, 78, 97, 80, 112, 89, 1, 8, 0, 0, 104, 16, 130, 162, 97, 98, 99, 100])
string = File.open("file.sz") do |file|
Compress::Snappy::Reader.open(file) do |sz|
sz.gets_to_end
end
end
string # => "abcd"
```
## Example: compress a file to snappy format
#
```crystal
require "snappy"
File.write("file.txt", "abcd")
File.open("./file.txt", "r") do |input_file|
File.open("./file.sz", "w") do |output_file|
Compress::Snappy::Writer.open(output_file) do |sz|
IO.copy(input_file, sz)
end
end
end
```
Refer to **specs** for usage examples.
## Development
To run all tests:
```
crystal spec
```
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Ali Naqvi](https://github.com/naqvis) - creator and maintainer