commonware-utils 0.0.54

Leverage common functionality across multiple primitives.
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

//! # Acknowledgements
//!
//! This code is inspired by [tokio-uring](https://github.com/tokio-rs/tokio-uring>) at commit 7761222.

use std::ops::Index;

use bytes::Bytes;

#[derive(Debug, Clone, PartialEq, Eq)]
/// A buffer whose memory is stable as long as its not reallocated.
pub enum StableBuf {
    Vec(Vec<u8>),
    BytesMut(bytes::BytesMut),
}

impl Default for StableBuf {
    fn default() -> Self {
        StableBuf::Vec(Vec::new())
    }
}

impl From<Vec<u8>> for StableBuf {
    fn from(v: Vec<u8>) -> Self {
        StableBuf::Vec(v)
    }
}

impl From<bytes::BytesMut> for StableBuf {
    fn from(b: bytes::BytesMut) -> Self {
        StableBuf::BytesMut(b)
    }
}

impl From<StableBuf> for Bytes {
    fn from(buf: StableBuf) -> Self {
        match buf {
            StableBuf::Vec(v) => Bytes::from(v),
            StableBuf::BytesMut(b) => b.freeze(),
        }
    }
}

impl Index<usize> for StableBuf {
    type Output = u8;

    fn index(&self, index: usize) -> &Self::Output {
        match self {
            StableBuf::Vec(v) => &v[index],
            StableBuf::BytesMut(b) => &b[index],
        }
    }
}

impl StableBuf {
    /// Returns a raw pointer to this buffer.
    pub fn as_mut_ptr(&mut self) -> *mut u8 {
        match self {
            StableBuf::Vec(v) => v.as_mut_ptr(),
            StableBuf::BytesMut(b) => b.as_mut_ptr(),
        }
    }

    /// Returns the length of the buffer.
    pub fn len(&self) -> usize {
        match self {
            StableBuf::Vec(v) => v.len(),
            StableBuf::BytesMut(b) => b.len(),
        }
    }

    /// Returns whether this buffer is empty.
    pub fn is_empty(&self) -> bool {
        match self {
            StableBuf::Vec(v) => v.is_empty(),
            StableBuf::BytesMut(b) => b.is_empty(),
        }
    }

    /// Copies the given byte slice into this buffer.
    /// `src` must not overlap with this buffer.
    /// Panics if `src` exceeds this buffer's length.
    pub fn put_slice(&mut self, src: &[u8]) {
        let dst = self.as_mut_ptr();
        unsafe {
            std::ptr::copy_nonoverlapping(src.as_ptr(), dst, src.len());
        }
    }

    /// Truncates the buffer to the specified length.
    pub fn truncate(&mut self, len: usize) {
        match self {
            StableBuf::Vec(v) => v.truncate(len),
            StableBuf::BytesMut(b) => b.truncate(len),
        }
    }
}

impl AsRef<[u8]> for StableBuf {
    fn as_ref(&self) -> &[u8] {
        match self {
            StableBuf::Vec(v) => v.as_ref(),
            StableBuf::BytesMut(b) => b.as_ref(),
        }
    }
}

impl AsMut<[u8]> for StableBuf {
    fn as_mut(&mut self) -> &mut [u8] {
        match self {
            StableBuf::Vec(v) => v.as_mut(),
            StableBuf::BytesMut(b) => b.as_mut(),
        }
    }
}