compio-io 0.10.0-rc.2

IO traits for completion based async IO
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

//! Extension module for automatic [`AncillaryData`] implementation via
//! bytemuck.
//!
//! See [`BitwiseAncillaryData`] for details.

use std::mem::MaybeUninit;

pub use bytemuck::{Pod, Zeroable};

use super::{AncillaryData, CodecError, copy_from_bytes, copy_to_bytes};

/// Marker trait to enable automatic `AncillaryData` implementation via
/// bytemuck.
///
/// Types that implement this trait (which requires [`bytemuck::Pod`]) will
/// automatically implement [`AncillaryData`] using a simple byte-wise
/// encoding/decoding.
///
/// # Example
///
/// ```
/// use compio_io::ancillary::bytemuck_ext;
///
/// #[derive(Clone, Copy)]
/// #[repr(C)]
/// struct MyType {
///     value: u32,
/// }
///
/// unsafe impl bytemuck_ext::Zeroable for MyType {}
/// unsafe impl bytemuck_ext::Pod for MyType {}
/// impl bytemuck_ext::BitwiseAncillaryData for MyType {}
///
/// // Now MyType automatically implements AncillaryData
/// ```
pub trait BitwiseAncillaryData: Pod {}

impl<T: BitwiseAncillaryData> AncillaryData for T {
    fn encode(&self, buffer: &mut [MaybeUninit<u8>]) -> Result<(), CodecError> {
        unsafe { copy_to_bytes(self, buffer) }
    }

    fn decode(buffer: &[u8]) -> Result<Self, CodecError> {
        unsafe { copy_from_bytes(buffer) }
    }
}

macro_rules! impl_bytemuck_marker {
    ($($t:ty),* $(,)?) => {
        $(
            impl BitwiseAncillaryData for $t {}
        )*
    };
}

impl_bytemuck_marker!(
    (),
    u8,
    u16,
    u32,
    u64,
    u128,
    usize,
    i8,
    i16,
    i32,
    i64,
    i128,
    isize,
    f32,
    f64,
);

impl<T: BitwiseAncillaryData, const N: usize> BitwiseAncillaryData for [T; N] {}