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 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
/// Define an `enum` that can be used as a type for a feattle
///
/// The generated `enum` will have these standard traits: `Debug`, `Clone`, `Copy`, `Eq`,
/// `PartialEq`, `PartialOrd`, `Ord`, `FromStr`, `Display`. And mainly, it will implement
/// [`crate::FeattleStringValue`] so that it can be used a feattle type.
///
/// Only `enum`s whose variants do not carry any extra information are supported.
///
/// # Examples
/// In the simplest form:
/// ```
/// use feattle_core::feattle_enum;
///
/// feattle_enum! {
/// enum Colors { Red, Green, Blue }
/// }
/// ```
///
/// However, it also works with other visibility keywords and additional attributes on the enum
/// itself or its variants. Those attributes will not be modified by this lib, allowing composition
/// with other libs. For example, you can also make the enum `Serialize`:
/// ```
/// use feattle_core::feattle_enum;
/// use serde::Serialize;
///
/// feattle_enum! {
/// #[derive(Serialize)]
/// pub(crate) enum Colors {
/// #[serde(rename = "R")]
/// Red,
/// #[serde(rename = "G")]
/// Green,
/// #[serde(rename = "B")]
/// Blue,
/// }
/// }
/// ```
#[macro_export]
macro_rules! feattle_enum {
(
$(#[$enum_meta:meta])*
$visibility:vis enum $name:ident {
$(
$(#[$variant_meta:meta])*
$variant:ident
),+ $(,)?
}
) => {
#[derive(Debug, Clone, Copy, Eq, PartialEq, PartialOrd, Ord)]
$(#[$enum_meta])*
$visibility enum $name {
$(
$(#[$variant_meta])*
$variant
),+
}
impl ::std::str::FromStr for $name {
type Err = $crate::__internal::ParseError;
fn from_str(s: &str) -> ::std::result::Result<Self, Self::Err> {
match s {
$(
stringify!($variant) => ::std::result::Result::Ok(Self::$variant)
),+,
_ => ::std::result::Result::Err($crate::__internal::ParseError)
}
}
}
impl ::std::fmt::Display for $name {
fn fmt(&self, f: &mut ::std::fmt::Formatter) -> ::std::fmt::Result {
let as_str = match self {
$(
Self::$variant => stringify!($variant)
),+
};
::std::write!(f, "{}", as_str)
}
}
impl $name {
const VARIANTS: &'static [&'static str] = &[
$(
stringify!($variant)
),+
];
}
impl $crate::FeattleStringValue for $name {
fn serialized_string_format() -> $crate::StringFormat {
let variants = Self::VARIANTS.join(", ");
$crate::StringFormat {
kind: $crate::StringFormatKind::Choices(&Self::VARIANTS),
tag: format!("enum {{{}}}", variants),
}
}
}
}
}
#[macro_export]
#[doc(hidden)]
macro_rules! __init_field {
($default:expr) => {
$default
};
() => {
Default::default()
};
}
/// The main macro of this crate, used to generate a struct that will provide the Feattles
/// functionalities.
///
/// See more at the [crate level](crate).
#[macro_export]
macro_rules! feattles {
(
$(#[$meta:meta])*
$visibility:vis struct $name:ident {
$(
$(#[doc=$description:tt])*
$key:ident: $type:ty $(= $default:expr)?
),*
$(,)?
}
) => {
use $crate::__internal;
$(#[$meta])*
#[derive(Debug)]
$visibility struct $name(__internal::FeattlesImpl<__Feattles>);
impl __internal::FeattlesPrivate for $name {
type FeattleStruct = __Feattles;
fn _read(
&self,
) -> __internal::RwLockReadGuard<'_, __internal::InnerFeattles<Self::FeattleStruct>>
{
self.0.inner_feattles.read()
}
fn _write(
&self,
) -> __internal::RwLockWriteGuard<'_, __internal::InnerFeattles<Self::FeattleStruct>>
{
self.0.inner_feattles.write()
}
}
impl __internal::Feattles for $name {
fn new(persistence: __internal::Arc<dyn __internal::Persist>) -> Self {
$name(__internal::FeattlesImpl::new(
persistence,
__Feattles {
$(
$key: __internal::Feattle::new(
stringify!($key),
concat!($($description),*).trim(),
$crate::__init_field!($($default)?),
)
),*
},
))
}
fn persistence(&self) -> &__internal::Arc<dyn __internal::Persist> {
&self.0.persistence
}
fn keys(&self) -> &'static [&'static str] {
&[$(stringify!($key)),*]
}
fn definition(&self, key: &str) -> Option<__internal::FeattleDefinition> {
use __internal::FeattlesPrivate;
let inner = self._read();
match key {
$(stringify!($key) => Some(inner.feattles_struct.$key.definition()),)*
_ => None,
}
}
}
impl $name {
$(
pub fn $key(&self) -> __internal::MappedRwLockReadGuard<$type> {
__internal::RwLockReadGuard::map(self.0.inner_feattles.read(), |inner| {
inner.feattles_struct.$key.value()
})
}
)*
}
#[derive(Debug)]
pub struct __Feattles {
$($key: __internal::Feattle<$type>),*
}
impl __internal::FeattlesStruct for __Feattles {
fn try_update(
&mut self,
key: &str,
value: Option<__internal::CurrentValue>,
) -> Result<Option<__internal::CurrentValue>, __internal::FromJsonError> {
match key {
$(stringify!($key) => self.$key.try_update(value),)*
_ => unreachable!(),
}
}
}
}
}