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
use std::fmt::Debug;
use specta::{DataType, Generics, Type, TypeMap};
/// Easily convert a non-Specta type into a Specta compatible type.
/// This will be typed as `any` in Typescript.
///
/// WARNING: When used with `Option<Any<T>>`, Typescript will not prompt you about nullability checks as `any | null` is coalesced to `any` in Typescript.
///
/// # Examples
///
/// This can be used as a type override.
/// ```rust
/// use serde::Serialize;
/// use specta::{Type, Any};
///
/// #[derive(Serialize, Type)]
/// pub struct Demo {
/// #[specta(type = Any)]
/// pub field: String,
/// }
/// ```
///
/// Or it can be used as a wrapper type.
/// ```rust
/// use serde::Serialize;
/// use specta::{Type, Any};
///
/// #[derive(Serialize, Type)]
/// pub struct Demo {
/// pub field: Any<String>,
/// }
/// ```
pub struct Any<T = ()>(T);
impl<T> Type for Any<T> {
fn inline(_: &mut TypeMap, _: Generics) -> DataType {
DataType::Any
}
}
impl<T: Debug> Debug for Any<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_tuple("Any").field(&self.0).finish()
}
}
impl<T: Clone> Clone for Any<T> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}
impl<T: Default> Default for Any<T> {
fn default() -> Self {
Self(T::default())
}
}
#[cfg(feature = "serde")]
impl<T: serde::Serialize> serde::Serialize for Any<T> {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
T::serialize(&self.0, serializer)
}
}
/// Easily convert a non-Specta type into a Specta compatible type.
/// This will be typed as `unknown` in Typescript.
///
/// # Examples
///
/// This can be used as a type override.
/// ```rust
/// use serde::Serialize;
/// use specta::{Type, Unknown};
///
/// #[derive(Serialize, Type)]
/// pub struct Demo {
/// #[specta(type = Unknown)]
/// pub field: String,
/// }
/// ```
///
/// Or it can be used as a wrapper type.
/// ```rust
/// use serde::Serialize;
/// use specta::{Type, Unknown};
///
/// #[derive(Serialize, Type)]
/// pub struct Demo {
/// pub field: Unknown<String>,
/// }
/// ```
pub struct Unknown<T = ()>(T);
impl<T> Type for Unknown<T> {
fn inline(_: &mut TypeMap, _: Generics) -> DataType {
DataType::Unknown
}
}
impl<T: Debug> Debug for Unknown<T> {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_tuple("Any").field(&self.0).finish()
}
}
impl<T: Clone> Clone for Unknown<T> {
fn clone(&self) -> Self {
Self(self.0.clone())
}
}
impl<T: Default> Default for Unknown<T> {
fn default() -> Self {
Self(T::default())
}
}
#[cfg(feature = "serde")]
impl<T: serde::Serialize> serde::Serialize for Unknown<T> {
fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where
S: serde::Serializer,
{
T::serialize(&self.0, serializer)
}
}