glommio 0.7.0

Glommio is a thread-per-core crate that makes writing highly parallel asynchronous applications in a thread-per-core architecture easier for rustaceans.
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
116
117
118
119
120
121

// Unless explicitly stated otherwise all files in this repository are licensed
// under the MIT/Apache-2.0 License, at your convenience
//
// This product includes software developed at Datadog (https://www.datadoghq.com/). Copyright 2020 Datadog, Inc.

/// Utility methods for working with byte slices/buffers.
pub trait ByteSliceExt {
    /// Copies the contents of `self` into the byte-slice `destination`.
    ///
    /// The copy starts at position `offset` into the `source` and copies
    /// as many bytes as possible until either we don't have more bytes to copy
    /// or `destination` doesn't have more space to hold them.
    ///
    /// ## Returns
    ///
    /// The amount of bytes written.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use glommio::{io::DmaFile, ByteSliceExt, LocalExecutor};
    ///
    /// let ex = LocalExecutor::default();
    /// ex.run(async {
    ///     let file = DmaFile::create("test.txt").await.unwrap();
    ///     let buf = file.alloc_dma_buffer(4096);
    ///     let mut vec = vec![0; 64];
    ///     let n = buf.read_at(0, &mut vec);
    ///     assert_eq!(n, 64); // read 64 bytes, the size of the buffer
    ///
    ///     let n = buf.read_at(4090, &mut vec);
    ///     assert_eq!(n, 6); // read 6 bytes, as there are only 6 bytes left from this offset
    ///     file.close().await.unwrap();
    /// });
    /// ```
    fn read_at<D: AsMut<[u8]> + ?Sized>(&self, offset: usize, destination: &mut D) -> usize;
}

/// Utility methods for working with mutable byte slices/buffers.
pub trait ByteSliceMutExt {
    /// Writes data to this buffer from a user-provided byte slice, starting at
    /// a particular offset
    ///
    /// ## Returns
    ///
    /// The amount of bytes written.
    ///
    /// # Examples
    ///
    /// ```no_run
    /// use glommio::{io::DmaFile, ByteSliceMutExt, LocalExecutor};
    ///
    /// let ex = LocalExecutor::default();
    /// ex.run(async {
    ///     let file = DmaFile::create("test.txt").await.unwrap();
    ///     let mut buf = file.alloc_dma_buffer(4096);
    ///     let vec = vec![1; 64];
    ///     let n = buf.write_at(0, &vec);
    ///     assert_eq!(n, 64); // wrote 64 bytes.
    ///
    ///     let n = buf.write_at(4090, &vec);
    ///     assert_eq!(n, 6); // wrote 6 bytes, as there are only 6 bytes left from this offset
    ///     file.close().await.unwrap();
    /// });
    /// ```
    fn write_at<S: AsRef<[u8]> + ?Sized>(&mut self, offset: usize, src: &S) -> usize;

    /// Writes the specified value into all bytes of this buffer
    fn memset(&mut self, value: u8);
}

#[inline]
fn slice_read_at(source: &[u8], offset: usize, destination: &mut [u8]) -> usize {
    if offset > source.len() {
        0
    } else {
        let len = core::cmp::min(destination.len(), source.len() - offset);
        destination[0..len].copy_from_slice(&source[offset..][..len]);
        len
    }
}

#[inline]
fn slice_write_at(destination: &mut [u8], offset: usize, source: &[u8]) -> usize {
    if offset > destination.len() {
        0
    } else {
        let len = std::cmp::min(source.len(), destination.len() - offset);
        destination[offset..offset + len].copy_from_slice(&source[0..len]);
        len
    }
}

#[inline]
fn slice_memset(destination: &mut [u8], value: u8) {
    for b in destination.iter_mut() {
        *b = value;
    }
}

// A NOTE about `#[inline]`: rustc currently only inlines code *across crate
// boundaries* if it is marked with `#[inline]`.

impl<T: AsRef<[u8]> + ?Sized> ByteSliceExt for T {
    #[inline]
    fn read_at<D: AsMut<[u8]> + ?Sized>(&self, offset: usize, destination: &mut D) -> usize {
        slice_read_at(self.as_ref(), offset, destination.as_mut())
    }
}

impl<T: AsMut<[u8]> + ?Sized> ByteSliceMutExt for T {
    #[inline]
    fn write_at<S: AsRef<[u8]> + ?Sized>(&mut self, offset: usize, src: &S) -> usize {
        slice_write_at(self.as_mut(), offset, src.as_ref())
    }

    #[inline]
    fn memset(&mut self, value: u8) {
        slice_memset(self.as_mut(), value)
    }
}