snappy 1.0.0-alpha

Haxe (C++/Neko) language bindings for the Snappy compression library.

Released 2014-11-22.

To install, run:

haxelib install snappy 1.0.0-alpha

See using Haxelib in Haxelib documentation for more information.

MaintainerMaddinXx
Websitehttps://github.com/MaddinXx/hx-snappy
Current version1.0.0-alpha
StatisticsInstalled 19 times
LicenseMIT
Tags compress, compression, cpp, google, neko, snappy

README.md

hx-snappy

Haxe (C++/Neko) language bindings for the Snappy compression library.

Build steps

You need the hxcpp library from haxelib:

haxelib install hxcpp

as well as the libsnappy development and runtime files:

apt-get install libsnappy1 libsnappy-dev // Debian/Ubuntu etc.
yum install snappy snappy-devel          // CentOS/RHEL etc.
brew install snappy                      // OSX (Homebrew)

afterwards, all is magic:

git clone -b develop git@github.com:MaddinXx/hx-snappy.git
cd hx-snappy
haxelib run hxcpp -DHXCPP_M64 build/build_bindings.hxml

Use -DHXCPP_M32 if on 32-bit system!

Compilation Flags

-D SNAPPY_LOADLAZY which will load the .ndll method implementations using the .Lib.loadLazy method rather than using normal load.

Nullability

Haxe has a special type Null<T> which is mainly for documentation purpose and for static platforms (so e.g. Int can be null). You can find its typedef here: http://api.haxe.org/Null.html

Trying to follow the documentation aspect, all methods that accept a nullable value (e.g. Null<Bytes>) can safely be called with null - it is ensured they will not throw an Exception or Error.

On the other hand, when a methods returns a value of type Null<T> that means, that the returned value may be null.

License

The MIT License (MIT)

Copyright (c) 2014 Michel Käser

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.