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 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372
// Some parts copyright Serde developers under the MIT / Apache-2.0 licenses at your option.
// See `serde` version `v1.0.169` for the parts where MIT / Apache-2.0 applies.
mod impls;
#[cfg(feature = "serde")]
pub mod serde;
use std::fmt;
/// A **data format** that can deserialize any data structure supported by SATs.
///
/// The `Serializer` trait in SATS performs the same function as [`serde::Serializer`] in [`serde`].
/// See the documentation of [`serde::Serializer`] for more information of the data model.
///
/// [`serde::Serializer`]: ::serde::Serializer
/// [`serde`]: https://crates.io/crates/serde
pub trait Serializer: Sized {
/// The output type produced by this `Serializer` during successful serialization.
///
/// Most serializers that produce text or binary output should set `Ok = ()`
/// and serialize into an [`io::Write`] or buffer contained within the `Serializer` instance.
/// Serializers that build in-memory data structures may be simplified by using `Ok` to propagate
/// the data structure around.
///
/// [`io::Write`]: https://doc.rust-lang.org/std/io/trait.Write.html
type Ok;
/// The error type when some error occurs during serialization.
type Error: Error;
/// Type returned from [`serialize_array`](Serializer::serialize_array)
/// for serializing the contents of the array.
type SerializeArray: SerializeArray<Ok = Self::Ok, Error = Self::Error>;
/// Type returned from [`serialize_map`](Serializer::serialize_map)
/// for serializing the contents of the map.
type SerializeMap: SerializeMap<Ok = Self::Ok, Error = Self::Error>;
/// Type returned from [`serialize_seq_product`](Serializer::serialize_seq_product)
/// for serializing the contents of the *unnamed* product.
type SerializeSeqProduct: SerializeSeqProduct<Ok = Self::Ok, Error = Self::Error>;
/// Type returned from [`serialize_named_product`](Serializer::serialize_named_product)
/// for serializing the contents of the *named* product.
type SerializeNamedProduct: SerializeNamedProduct<Ok = Self::Ok, Error = Self::Error>;
/// Serialize a `bool` value.
fn serialize_bool(self, v: bool) -> Result<Self::Ok, Self::Error>;
/// Serialize a `u8` value.
fn serialize_u8(self, v: u8) -> Result<Self::Ok, Self::Error>;
/// Serialize a `u16` value.
fn serialize_u16(self, v: u16) -> Result<Self::Ok, Self::Error>;
/// Serialize a `u32` value.
fn serialize_u32(self, v: u32) -> Result<Self::Ok, Self::Error>;
/// Serialize a `u64` value.
fn serialize_u64(self, v: u64) -> Result<Self::Ok, Self::Error>;
/// Serialize a `u128` value.
fn serialize_u128(self, v: u128) -> Result<Self::Ok, Self::Error>;
/// Serialize an `i8` value.
fn serialize_i8(self, v: i8) -> Result<Self::Ok, Self::Error>;
/// Serialize an `i16` value.
fn serialize_i16(self, v: i16) -> Result<Self::Ok, Self::Error>;
/// Serialize an `i32` value.
fn serialize_i32(self, v: i32) -> Result<Self::Ok, Self::Error>;
/// Serialize an `i64` value.
fn serialize_i64(self, v: i64) -> Result<Self::Ok, Self::Error>;
/// Serialize an `i128` value.
fn serialize_i128(self, v: i128) -> Result<Self::Ok, Self::Error>;
/// Serialize an `f32` value.
fn serialize_f32(self, v: f32) -> Result<Self::Ok, Self::Error>;
/// Serialize an `f64` value.
fn serialize_f64(self, v: f64) -> Result<Self::Ok, Self::Error>;
/// Serialize a `&str` string slice.
fn serialize_str(self, v: &str) -> Result<Self::Ok, Self::Error>;
/// Serialize a `&[u8]` byte slice.
fn serialize_bytes(self, v: &[u8]) -> Result<Self::Ok, Self::Error>;
/// Begin to serialize a variably sized array.
/// This call must be followed by zero or more calls to [`SerializeArray::serialize_element`],
/// then a call to [`SerializeArray::end`].
///
/// The argument is the number of elements in the sequence.
fn serialize_array(self, len: usize) -> Result<Self::SerializeArray, Self::Error>;
/// Begin to serialize a variably sized map.
/// This call must be followed by zero or more calls to [`SerializeMap::serialize_element`],
/// then a call to [`SerializeMap::end`].
///
/// The argument is the number of elements in the map.
fn serialize_map(self, len: usize) -> Result<Self::SerializeMap, Self::Error>;
/// Begin to serialize a product with unnamed fields.
/// This call must be followed by zero or more calls to [`SerializeSeqProduct::serialize_element`],
/// then a call to [`SerializeSeqProduct::end`].
///
/// The argument is the number of fields in the product.
fn serialize_seq_product(self, len: usize) -> Result<Self::SerializeSeqProduct, Self::Error>;
/// Begin to serialize a product with named fields.
/// This call must be followed by zero or more calls to [`SerializeNamedProduct::serialize_element`],
/// then a call to [`SerializeNamedProduct::end`].
///
/// The argument is the number of fields in the product.
fn serialize_named_product(self, len: usize) -> Result<Self::SerializeNamedProduct, Self::Error>;
/// Serialize a sum value provided the chosen `tag`, `name`, and `value`.
fn serialize_variant<T: Serialize + ?Sized>(
self,
tag: u8,
name: Option<&str>,
value: &T,
) -> Result<Self::Ok, Self::Error>;
/// Serialize the given `bsatn` encoded data of type `ty`.
///
/// This is a concession to performance,
/// allowing some implementations to write the buffer directly.
///
/// # Safety
///
/// - `AlgebraicValue::decode(ty, &mut bsatn).is_ok()`.
/// That is, `bsatn` encodes a valid element of `ty`.
unsafe fn serialize_bsatn(self, ty: &AlgebraicType, bsatn: &[u8]) -> Result<Self::Ok, Self::Error>;
/// Serialize the given `bsatn` encoded data of type `ty`.
///
/// The data is provided as an iterator of chunks, at arbitrary boundaries,
/// with a total concatenated length of `total_bsatn_len` which callers can assume.
///
/// An implementation of this method is semantically the same as:
/// ```rust,ignore
/// let mut buf = Vec::new();
/// for chunk in bsatn {
/// buf.extend(chunk);
/// }
/// ser.serialize_bsatn(&buf);
/// ```
///
/// This method is a concession to performance,
/// allowing some implementations to write the buffer directly.
///
/// The parameter `I` is required to be `Clone` only for `debug_assert!` purposes.
///
/// # Safety
///
/// - `total_bsatn_len == bsatn.map(|c| c.len()).sum() <= isize::MAX`
/// - Let `buf` be defined as above, i.e., the bytes of `bsatn` concatenated.
/// Then `AlgebraicValue::decode(ty, &mut buf).is_ok()`.
/// That is, `buf` encodes a valid element of `ty`.
unsafe fn serialize_bsatn_in_chunks<'a, I: Clone + Iterator<Item = &'a [u8]>>(
self,
ty: &AlgebraicType,
total_bsatn_len: usize,
bsatn: I,
) -> Result<Self::Ok, Self::Error>;
/// Serialize the given `string`.
///
/// The string is provided as an iterator of chunks, at arbitrary boundaries,
/// with a total concatenated length of `total_len` which callers can trust.
///
/// An implementation of this method is semantically the same as:
/// ```rust,ignore
/// let mut buf = Vec::new();
/// for chunk in string {
/// buf.extend(chunk);
/// }
/// let str = unsafe { core::str::from_utf8_unchecked(&buf) };
/// ser.serialize_str(str);
/// ```
///
/// This method is a concession to performance,
/// allowing some implementations to write the buffer directly.
///
/// The parameter `I` is required to be `Clone` only for `debug_assert!` purposes.
///
/// # Safety
///
/// - `total_len == string.map(|c| c.len()).sum() <= isize::MAX`
/// - Let `buf` be the bytes of `string` concatenated.
/// Then `core::str::from_utf8(&buf).is_ok()`.
/// That is, `buf` is valid UTF-8.
/// Note however that individual chunks need not be valid UTF-8,
/// as multi-byte characters may be split across chunk boundaries.
unsafe fn serialize_str_in_chunks<'a, I: Clone + Iterator<Item = &'a [u8]>>(
self,
total_len: usize,
string: I,
) -> Result<Self::Ok, Self::Error>;
}
pub use spacetimedb_bindings_macro::Serialize;
use crate::AlgebraicType;
/// A **data structure** that can be serialized into any data format supported by SATS.
///
/// In most cases, implementations of `Serialize` may be `#[derive(Serialize)]`d.
///
/// The `Serialize` trait in SATS performs the same function as [`serde::Serialize`] in [`serde`].
/// See the documentation of [`serde::Serialize`] for more information of the data model.
///
/// [`serde::Serialize`]: ::serde::Serialize
/// [`serde`]: https://crates.io/crates/serde
pub trait Serialize {
/// Serialize `self` in the data format of `S` using the provided `serializer`.
fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>;
/// Used in the `Serialize for Vec<T>` implementation
/// to allow a specialized serialization of `Vec<T>` as bytes.
#[doc(hidden)]
#[inline(always)]
fn __serialize_array<S: Serializer>(this: &[Self], serializer: S) -> Result<S::Ok, S::Error>
where
Self: Sized,
{
let mut vec = serializer.serialize_array(this.len())?;
for elem in this {
vec.serialize_element(elem)?;
}
vec.end()
}
}
/// The base trait serialization error types must implement.
pub trait Error {
/// Returns an error derived from `msg: impl Display`.
fn custom<T: fmt::Display>(msg: T) -> Self;
}
impl Error for String {
fn custom<T: fmt::Display>(msg: T) -> Self {
msg.to_string()
}
}
impl Error for std::convert::Infallible {
fn custom<T: fmt::Display>(msg: T) -> Self {
panic!("error generated for Infallible serializer: {msg}")
}
}
/// Returned from [`Serializer::serialize_array`].
///
/// This provides a continuation of sorts
/// where you can call [`serialize_element`](SerializeArray::serialize_element) however many times
/// and then finally the [`end`](SerializeArray::end) is reached.
pub trait SerializeArray {
/// Must match the `Ok` type of any `Serializer` that uses this type.
type Ok;
/// Must match the `Error` type of any `Serializer` that uses this type.
type Error: Error;
/// Serialize an array `element`.
fn serialize_element<T: Serialize + ?Sized>(&mut self, element: &T) -> Result<(), Self::Error>;
/// Consumes and finalizes the array serializer returning the `Self::Ok` data.
fn end(self) -> Result<Self::Ok, Self::Error>;
}
/// Returned from [`Serializer::serialize_map`].
///
/// This provides a continuation of sorts
/// where you can call [`serialize_entry`](SerializeMap::serialize_entry) however many times
/// and then finally the [`end`](SerializeMap::end) is reached.
pub trait SerializeMap {
/// Must match the `Ok` type of any `Serializer` that uses this type.
type Ok;
/// Must match the `Error` type of any `Serializer` that uses this type.
type Error: Error;
/// Serialize a map entry given by its `key` and `value`.
fn serialize_entry<K: Serialize + ?Sized, V: Serialize + ?Sized>(
&mut self,
key: &K,
value: &V,
) -> Result<(), Self::Error>;
/// Consumes and finalizes the map serializer returning the `Self::Ok` data.
fn end(self) -> Result<Self::Ok, Self::Error>;
}
/// Returned from [`Serializer::serialize_seq_product`].
///
/// This provides a continuation of sorts
/// where you can call [`serialize_element`](SerializeSeqProduct::serialize_element) however many times
/// and then finally the [`end`](SerializeSeqProduct::end) is reached.
pub trait SerializeSeqProduct {
/// Must match the `Ok` type of any `Serializer` that uses this type.
type Ok;
/// Must match the `Error` type of any `Serializer` that uses this type.
type Error: Error;
/// Serialize an unnamed product `element`.
fn serialize_element<T: Serialize + ?Sized>(&mut self, element: &T) -> Result<(), Self::Error>;
/// Consumes and finalizes the product serializer returning the `Self::Ok` data.
fn end(self) -> Result<Self::Ok, Self::Error>;
}
/// Returned from [`Serializer::serialize_named_product`].
///
/// This provides a continuation of sorts
/// where you can call [`serialize_element`](SerializeNamedProduct::serialize_element) however many times
/// and then finally the [`end`](SerializeNamedProduct::end) is reached.
pub trait SerializeNamedProduct {
/// Must match the `Ok` type of any `Serializer` that uses this type.
type Ok;
/// Must match the `Error` type of any `Serializer` that uses this type.
type Error: Error;
/// Serialize a named product `element` with `name`.
fn serialize_element<T: Serialize + ?Sized>(&mut self, name: Option<&str>, elem: &T) -> Result<(), Self::Error>;
/// Consumes and finalizes the product serializer returning the `Self::Ok` data.
fn end(self) -> Result<Self::Ok, Self::Error>;
}
/// Forwards the implementation of a named product value
/// to the implementation of the unnamed kind,
/// thereby ignoring any field names.
pub struct ForwardNamedToSeqProduct<S> {
/// The unnamed product serializer.
tup: S,
}
impl<S> ForwardNamedToSeqProduct<S> {
/// Returns a forwarder based on the provided unnamed product serializer.
pub fn new(tup: S) -> Self {
Self { tup }
}
/// Forwards the serialization of a named product of `len` fields
/// to an unnamed serialization format.
pub fn forward<Ser>(ser: Ser, len: usize) -> Result<Self, Ser::Error>
where
Ser: Serializer<SerializeSeqProduct = S>,
{
ser.serialize_seq_product(len).map(Self::new)
}
}
impl<S: SerializeSeqProduct> SerializeNamedProduct for ForwardNamedToSeqProduct<S> {
type Ok = S::Ok;
type Error = S::Error;
fn serialize_element<T: Serialize + ?Sized>(&mut self, _name: Option<&str>, elem: &T) -> Result<(), Self::Error> {
self.tup.serialize_element(elem)
}
fn end(self) -> Result<Self::Ok, Self::Error> {
self.tup.end()
}
}