ladata 0.0.29

A simple & modular data model.
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

// ladata::unit::traits
//
//! The traits for unitary data.
//
// - DataType
// - DataTypeCopy
// - DataUnit
// - DataUnitCopy
// - DataRaw

use core::fmt::Debug;

/// Common trait for *data types*.
///
/// Allows extending `DataType*`**`With`** versions with custom *types*.
///
/// # See also
/// - [`DataTypeCopy`]
/// - [`DataUnitCopy`]
/// - [`DataUnit`]
pub trait DataType: Copy + Debug {
    /// Returns the alignment of the data represented by the current type.
    fn data_align(&self) -> usize;

    /// Returns the size of the data represented by this type.
    fn data_size(&self) -> usize;

    /// Returns true if the data represented by this type is [`Copy`].
    fn is_copy(&self) -> bool;
}

/// Common (marker) trait for `Copy` *data types*.
///
/// Allows extending `DataType*Copy`**`With`** versions with custom *types*.
///
/// # Coherence
///
/// The `DataType::`[`is_copy`][DataType#method.is_copy]
/// super-trait method should probably return `true` as well.
///
/// # See also
/// - [`DataType`]
/// - [`DataUnit`]
/// - [`DataUnitCopy`]
pub trait DataTypeCopy: DataType {}

/// Common trait for *data units*.
///
/// Allows extending `DataUnit*`**`With`** versions.
///
/// See also:
/// - [`DataUnitCopy`]
/// - [`DataTypeCopy`]
/// - [`DataType`]
pub trait DataUnit: Debug {
    /// Whether the data type in the current variant is [`Copy`].
    fn is_copy(&self) -> bool;
}

/// Common (marker) trait for `Copy` *data units*.
///
/// Allows extending `DataUnit*Copy`**`With`** versions.
///
/// # Coherence
///
/// The `DataUnit::`[`is_copy`][DataUnit#method.is_copy]
/// super-trait method should probably return `true` as well.
///
/// # See also
/// - [`DataUnit`]
/// - [`DataType`]
/// - [`DataTypeCopy`]
pub trait DataUnitCopy: DataUnit + Copy {}

/// Common trait for *unsafe data units*.
///
/// # Safety
/// TODO
///
#[cfg(feature = "unsafe_unit")]
#[cfg_attr(feature = "nightly", doc(cfg(feature = "not(safe)")))]
pub unsafe trait DataRaw {}

/// Comon (marker) trait for *unsafe* `Copy` *data units*.
///
/// # Safety
/// TODO
///
#[cfg(feature = "unsafe_unit")]
#[cfg_attr(feature = "nightly", doc(cfg(feature = "not(safe)")))]
pub unsafe trait DataRawCopy: DataRaw + Copy {}