abin 0.1.6

A library for working with binaries and strings. The library tries to avoid heap-allocations / memory-copy whenever possible by automatically choosing a reasonable strategy: stack for small binaries; static-lifetime-binary or reference-counting.
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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

use std::alloc::System;
use std::cmp::Ordering;
use std::hash::{Hash, Hasher};
use std::ops::Range;

use stats_alloc::{StatsAlloc, INSTRUMENTED_SYSTEM};

use abin::{AnyBin, Bin, BinFactory, IntoUnSyncView, NewBin, NewSBin};
use utils::*;

#[global_allocator]
static GLOBAL: &StatsAlloc<System> = &INSTRUMENTED_SYSTEM;

pub mod utils;

/// Tests whether a vec/slice and a bin behave the same.
#[test]
fn test_same_behaviour_basics() {
    // make sure there are no leaks
    mem_scoped(&GLOBAL, &MaNoLeak, || {
        same_behaviour_basics_static(&[]);
        same_behaviour_basics_static(&[3]);
        same_behaviour_basics_static(&[4, 8]);
        same_behaviour_basics_static(&[4, 8, 4, 8, 78, 90, 0, 47]);

        // small
        for index in 0..1024 {
            let bin_gen = BinGen::new(index as u8, index as usize);
            let vec = bin_gen.generate_to_vec_shrink(0);
            same_behaviour_non_static(vec);
        }

        // large
        for step in 1..15 {
            let index = step * 2007;
            let bin_gen = BinGen::new(index as u8, index as usize);
            let vec = bin_gen.generate_to_vec_shrink(0);
            same_behaviour_non_static(vec);
        }
    });
}

fn same_behaviour_basics_static(original: &'static [u8]) {
    same_behaviour(original, NewBin::from_static(original).un_sync());
}

fn same_behaviour_non_static(original: Vec<u8>) {
    let rc_bin = NewBin::from_given_vec(original.clone());
    let arc_bin = NewSBin::from_given_vec(original.clone()).un_sync();

    same_behaviour(original.as_slice(), rc_bin);
    same_behaviour(original.as_slice(), arc_bin);
}

fn same_behaviour(original: &[u8], bin: Bin) {
    same_behaviour_basics(original, &bin);
    {
        let bin_cloned = bin.clone();
        same_behaviour_basics(original, &bin_cloned);
    }
    let bin_sliced_full = bin.slice(0..bin.len()).unwrap();
    same_behaviour_basics(original, &bin_sliced_full);
}

fn same_behaviour_basics(original: &[u8], bin: &Bin) {
    assert_eq!(original.len(), bin.len(), "Same length");
    assert_eq!(original, bin.as_slice(), "Slice equality");
    same_hash(original, bin);

    // slice: edge cases
    check_slice(original, &bin, 0..0);
    check_slice(original, &bin, 0..1);
    check_slice(original, &bin, 1..0);
    check_slice(original, &bin, 1..1);

    // slice: out of range
    check_slice(original, &bin, 0..(bin.len() + 1));
    check_slice(original, &bin, 0..core::usize::MAX);
    // just within range
    check_slice(original, &bin, 0..bin.len());

    let cloned_bin = bin.clone();
    assert_eq!(bin, &cloned_bin);
    assert_eq!(bin.partial_cmp(&cloned_bin), Some(Ordering::Equal));
    assert_eq!(bin.cmp(&cloned_bin), Ordering::Equal);
}

/// a binary produces the same hash as a slice.
fn same_hash(original: &[u8], bin: &Bin) {
    let mut hasher1 = std::collections::hash_map::DefaultHasher::default();
    original.hash(&mut hasher1);

    let mut hasher2 = std::collections::hash_map::DefaultHasher::default();
    bin.hash(&mut hasher2);

    assert_eq!(hasher1.finish(), hasher2.finish());
}

fn check_slice(original: &[u8], bin: &Bin, range: Range<usize>) {
    let bin_sliced = bin.slice(range.clone());

    let original_sliced = original.get(range);

    if let Some(bin_sliced) = bin_sliced {
        if let Some(original_sliced) = original_sliced {
            assert_eq!(bin_sliced.as_slice(), original_sliced);
            let vec = bin_sliced.into_vec();
            assert_eq!(vec.as_slice(), original_sliced);
        } else {
            panic!("Bin slice returned a result but slice slice did not!")
        }
    } else {
        assert!(original_sliced.is_none());
    }
}