bcast 0.0.29

Low latency broadcast (SPMC) buffer designed to work with shared memory.
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

use std::ops::{Deref, DerefMut};
use std::ptr::{slice_from_raw_parts, slice_from_raw_parts_mut};

/// Wrapper over array of bytes that provides 128-byte alignment.
/// ## Example
/// ```no_run
/// use bcast::util::AlignedBytes;
///
/// let bytes = AlignedBytes::<1024>::new();
/// // we can now work with bytes as if it was &[u8].
/// ```
#[repr(align(128))]
pub struct AlignedBytes<const N: usize>([u8; N]);

impl<const N: usize> AlignedBytes<N> {
    /// Construct new wrapper with specific size `N`.
    #[inline]
    pub const fn new() -> AlignedBytes<N> {
        Self([0; N])
    }
}

impl<const N: usize> Default for AlignedBytes<N> {
    #[inline]
    fn default() -> Self {
        Self::new()
    }
}

impl<const N: usize> Deref for AlignedBytes<N> {
    type Target = [u8];

    #[inline]
    fn deref(&self) -> &Self::Target {
        unsafe { &*slice_from_raw_parts(self.0.as_ptr(), N) }
    }
}

impl<const N: usize> DerefMut for AlignedBytes<N> {
    #[inline]
    fn deref_mut(&mut self) -> &mut Self::Target {
        unsafe { &mut *slice_from_raw_parts_mut(self.0.as_mut_ptr(), N) }
    }
}