devela 0.27.0

A development layer of coherence.
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
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139

// devela::data::value::traits
//
//! Defines the traits [`DataType`], [`DataValue`], [`DataRaw`], and related.
//
// - DataType
// - DataTypeCopy
// - DataValue
// - DataValueCopy
// - DataRaw
// - DataRawCopy

use crate::Debug;

#[doc = crate::_tags!(value)]
/// Common trait for enumerating *data types*.
#[doc = crate::_doc_location!("data/table/value")]
///
/// Allows extending `DataType*`**`With`** versions with custom *types*.
///
/// # See also
/// - [`DataTypeCopy`]
/// - [`DataValueCopy`]
/// - [`DataValue`]
pub trait DataType: Debug {
    /// The `DataValue` type that pairs with this `DataType`.
    type Value: DataValue;

    /// Returns whether all values represented by this type are `Copy`.
    fn data_values_are_copy() -> bool;

    /// Returns whether the specific value for this type is `Copy`.
    fn data_value_is_copy(&self) -> bool;

    /// Returns the default value for this type, or `None` if not available.
    fn data_value_default(&self) -> Option<Self::Value>;

    /// Returns the alignment of the value represented by this type.
    fn data_value_align(&self) -> usize;

    /// Returns the size of the value represented by this type.
    fn data_value_size(&self) -> usize;
}

#[doc = crate::_tags!(value)]
/// Common trait for enumerating `Copy`-constrained *data types*.
#[doc = crate::_doc_location!("data/table/value")]
///
/// 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`]
/// - [`DataValue`]
/// - [`DataValueCopy`]
pub trait DataTypeCopy: DataType + Copy
where
    Self::Value: DataValueCopy,
{
    /// Returns the default value for this `Copy` type, or `None` if not available.
    ///
    /// The default implementation forwards to [`DataType::data_value_default`].
    fn data_value_copy_default(&self) -> Option<Self::Value> {
        self.data_value_default()
    }
}

#[doc = crate::_tags!(value)]
/// Common trait for enumerating *data values*.
#[doc = crate::_doc_location!("data/table/value")]
///
/// Allows extending `DataValue*`**`With`** versions.
///
/// See also:
/// - [`DataValueCopy`]
/// - [`DataTypeCopy`]
/// - [`DataType`]
pub trait DataValue: Debug {
    /// The `DataType` type that pairs with this `DataValue`.
    type Type: DataType;

    /// Returns whether all values are `Copy`.
    fn data_values_are_copy() -> bool;

    /// Returns the data type of this value.
    fn data_type(&self) -> Self::Type;

    /// Returns whether the specific value is `Copy`.
    fn data_value_is_copy(&self) -> bool;
}

#[doc = crate::_tags!(value)]
/// Common trait for enumerating `Copy`-constrained *data values*.
#[doc = crate::_doc_location!("data/table/value")]
///
/// Allows extending `DataValue*Copy`**`With`** versions.
///
/// # Coherence
///
/// The `DataValue::`[`is_copy`][DataValue#method.is_copy]
/// super-trait method should probably return `true` as well.
///
/// # See also
/// - [`DataValue`]
/// - [`DataType`]
/// - [`DataTypeCopy`]
//
// NOTE we must not require `where Self::Type: DataTypeCopy` to avoid loops.
pub trait DataValueCopy: DataValue + Copy {
    /// Returns the data type associated with this `Copy` value.
    ///
    /// The default implementation forwards to [`DataValue::data_type`].
    fn data_type_copy(&self) -> Self::Type {
        self.data_type()
    }
}

#[doc = crate::_tags!(value)]
/// Common unsafe trait for enumerating untagged *raw data values*.
#[doc = crate::_doc_location!("data/table/value")]
///
/// # Safety
/// You have to know what you're doing.
#[cfg(all(not(feature = "safe_data"), feature = "unsafe_layout"))]
#[cfg_attr(nightly_doc, doc(cfg(feature = "unsafe_layout")))]
pub unsafe trait DataRaw {}

#[doc = crate::_tags!(value)]
/// Common unsafe trait for enumerating `Copy`-constrained untagged *raw data values*.
#[doc = crate::_doc_location!("data/table/value")]
///
/// # Safety
/// You have to know what you're doing.
#[cfg(all(not(feature = "safe_data"), feature = "unsafe_layout"))]
#[cfg_attr(nightly_doc, doc(cfg(feature = "unsafe_layout")))]
pub unsafe trait DataRawCopy: DataRaw + Copy {}