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

use crate::spi::{BinData, FnTable};
use crate::SBin;

/// Unsafe interface for `Bin`. This is only to be used if you want to
/// implement your own binary type.
///
/// Note: Naming (the `_`) is a bit awkward: This is intentional: This trait is implemented
/// for `Bin` and we want to make sure the IDE does not auto-complete; or the user uses these
/// functions accidentally.
pub unsafe trait UnsafeBin {
    /// New binary from given data with given function table.
    ///
    /// # Safety
    ///
    /// This is unsafe. Use this only if you implement your own binary type and you know what
    /// you're doing. See the default-implementation for details.
    unsafe fn _new(data: BinData, fn_table: &'static FnTable) -> Self;

    /// A reference to the binary data.
    ///
    /// # Safety
    ///
    /// This is unsafe. Use this only if you implement your own binary type and you know what
    /// you're doing. See the default-implementation for details.
    unsafe fn _data(&self) -> &BinData;

    /// A mutable reference to the binary data.
    ///
    /// # Safety
    ///
    /// This is unsafe. Use this only if you implement your own binary type and you know what
    /// you're doing. See the default-implementation for details.
    unsafe fn _data_mut(&mut self) -> &mut BinData;

    /// Gets the function-table.
    ///
    /// # Safety
    ///
    /// This is unsafe. Use this only if you implement your own binary type and you know what
    /// you're doing. See the default-implementation for details.
    unsafe fn _fn_table(&self) -> &'static FnTable;

    /// Wraps this binary in a sync-binary. This will just be a view (it does not synchronize). So
    /// be sure the actual implementation (the function table) is really `Send + Sync`.
    ///
    /// # Safety
    ///
    /// This is unsafe. Use this only if you implement your own binary type and you know what
    /// you're doing. See the default-implementation for details.
    unsafe fn _into_sync(self) -> SBin;
}