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
mod arg;
pub(crate) mod result;
use std::borrow::Cow;
pub use arg::FunctionArg;
pub(crate) use result::*;
/// Returns a [`FunctionDataType`] for a given function that has been annotated with
/// [`specta`](macro@crate::specta).
///
/// # Examples
///
/// ```rust
/// use specta::*;
///
/// #[specta]
/// fn some_function(name: String, age: i32) -> bool {
/// true
/// }
///
/// fn main() {
/// let typ = fn_datatype!(some_function);
///
/// assert_eq!(typ.name, "some_function");
/// assert_eq!(typ.args.len(), 2);
/// assert_eq!(typ.result, Some(DataType::Primitive(PrimitiveType::bool)));
/// }
/// ```
#[macro_export]
macro_rules! fn_datatype {
($function:path) => {{
let mut type_map = $crate::TypeMap::default();
$crate::fn_datatype!(type_map; $function)
}};
($type_map:ident; $function:path) => {{
let type_map: &mut $crate::TypeMap = &mut $type_map;
$crate::internal::internal_fn_datatype!($function);
result
}};
}
/// Collects function types into a [`Vec`],
/// and all downstream types into a [`TypeMap`] instance.
///
/// Specifying a `type_map` argument allows a custom [`TypeMap`] to be used.
///
/// # Examples
///
/// ```rust
/// use specta::*;
///
/// #[specta]
/// fn some_function(name: String, age: i32) -> bool {
/// true
/// }
///
/// fn main() {
/// // `type_defs` is created internally
/// let (functions, type_defs) = function::collect_functions![some_function];
///
/// let custom_type_defs = TypeMap::default();
///
/// // `type_defs` is provided.
/// // This can be used when integrating multiple specta-enabled libraries.
/// let (functions, custom_type_defs) = function::collect_functions![
/// custom_type_defs; // You can provide a custom map to collect the types into
/// some_function
/// ];
/// }
/// ````
#[macro_export]
macro_rules! collect_functions {
($type_map:ident; $($command:path),* $(,)?) => {{
let mut type_map: $crate::TypeMap = $type_map;
([$($crate::fn_datatype!(type_map; $command)),*]
.into_iter()
.collect::<Vec<$crate::function::FunctionDataType>>(), type_map)
}};
($($command:path),* $(,)?) => {{
let mut type_map = $crate::TypeMap::default();
$crate::function::collect_functions!(type_map; $($command),*)
}};
}
pub type CollectFunctionsResult = (Vec<FunctionDataType>, TypeMap);
pub use crate::collect_functions;
use crate::{DataType, DeprecatedType, TypeMap};
// TODO: Probs move this into the `DataType` module???
/// Contains type information about a function annotated with [`specta`](macro@crate::specta).
/// Returned by [`fn_datatype`].
#[derive(Debug, Clone)]
pub struct FunctionDataType {
/// Whether the function is async.
pub asyncness: bool,
/// The function's name.
pub name: Cow<'static, str>,
/// The name and type of each of the function's arguments.
pub args: Vec<(Cow<'static, str>, DataType)>,
/// The return type of the function.
pub result: Option<DataType>,
/// The function's documentation. Detects both `///` and `#[doc = ...]` style documentation.
pub docs: Cow<'static, str>,
/// The deprecated status of the function.
pub deprecated: Option<DeprecatedType>,
}
/// Implemented by functions that can be annoatated with [`specta`](crate::specta).
pub trait Function<TMarker> {
/// Gets the type of a function as a [`FunctionDataType`].
fn to_datatype(
asyncness: bool,
name: Cow<'static, str>,
type_map: &mut TypeMap,
fields: &[Cow<'static, str>],
docs: Cow<'static, str>,
deprecated: Option<DeprecatedType>,
no_return_type: bool,
) -> FunctionDataType;
}
impl<TResultMarker, TResult: FunctionResult<TResultMarker>> Function<TResultMarker>
for fn() -> TResult
{
fn to_datatype(
asyncness: bool,
name: Cow<'static, str>,
type_map: &mut TypeMap,
_fields: &[Cow<'static, str>],
docs: Cow<'static, str>,
deprecated: Option<DeprecatedType>,
no_return_type: bool,
) -> FunctionDataType {
FunctionDataType {
asyncness,
name,
args: vec![],
result: (!no_return_type).then(|| TResult::to_datatype(type_map)),
docs,
deprecated,
}
}
}
macro_rules! impl_typed_command {
( impl $($i:ident),* ) => {
paste::paste! {
impl<
TResultMarker,
TResult: FunctionResult<TResultMarker>,
$($i: FunctionArg),*
> Function<TResultMarker> for fn($($i),*) -> TResult {
fn to_datatype(
asyncness: bool,
name: Cow<'static, str>,
type_map: &mut TypeMap,
fields: &[Cow<'static, str>],
docs: Cow<'static, str>,
deprecated: Option<DeprecatedType>,
no_return_type: bool,
) -> FunctionDataType {
let mut fields = fields.into_iter();
FunctionDataType {
asyncness,
name,
docs,
deprecated,
args: [$(
fields
.next()
.map_or_else(
|| None,
|field| $i::to_datatype(type_map).map(|ty| (field.clone(), ty))
)
),*,]
.into_iter()
.filter_map(|v| v)
.collect::<Vec<_>>(),
result: (!no_return_type).then(|| TResult::to_datatype(type_map)),
}
}
}
}
};
( $i2:ident $(, $i:ident)* ) => {
impl_typed_command!(impl $i2 $(, $i)* );
impl_typed_command!($($i),*);
};
() => {};
}
impl_typed_command!(T1, T2, T3, T4, T5, T6, T7, T8, T9, T10);