blosc-rs 0.1.0

Unsafe Rust bindings for blosc - a blocking, shuffling and lossless compression library
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52

# blosc-rs
Rust bindings for blosc - a blocking, shuffling and lossless compression library.

Provide a safe interface to the [blosc](https://github.com/Blosc/c-blosc) library.
The crate has zero dependencies.

### Getting Started

To use this library, add the following to your `Cargo.toml`:
```toml
[dependencies]
blosc-rs = "0.1"

# Or alternatively, rename the crate to `blosc`
blosc = { package = "blosc-rs", version = "0.1" }
```

In the following example we compress a vector of integers and then decompress it back:
```rust
use blosc_rs::{CLevel, CompressAlgo, Shuffle, compress, decompress};

let data: [i32; 7] = [1, 2, 3, 4, 5, 6, 7];

let data_bytes = unsafe {
    std::slice::from_raw_parts(
        data.as_ptr() as *const u8,
        data.len() * std::mem::size_of::<i32>(),
    )
};
let numinternalthreads = 4;
let compressed = compress(
    CLevel::L5,
    Shuffle::Byte,
    std::mem::size_of::<i32>(), // itemsize
    data_bytes,
    &CompressAlgo::Blosclz,
    None, // automatic block size
    numinternalthreads,
)
.unwrap();

let decompressed = decompress(&compressed, numinternalthreads).unwrap();
// SAFETY: we know the data is of type i32
let decompressed: &[i32] = unsafe {
    std::slice::from_raw_parts(
        decompressed.as_ptr() as *const i32,
        decompressed.len() / std::mem::size_of::<i32>(),
    )
};

assert_eq!(data, *decompressed);
```