Skip to content

Commit

Permalink
Move comments
Browse files Browse the repository at this point in the history
  • Loading branch information
kazimuth committed Dec 12, 2024
1 parent 3fb328b commit 6137dc2
Showing 1 changed file with 5 additions and 6 deletions.
11 changes: 5 additions & 6 deletions crates/sats/src/de.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,7 @@ use core::marker::PhantomData;
use smallvec::SmallVec;
use std::borrow::Borrow;

/// A **data format** that can deserialize any data structure supported by
/// the SpacetimeDB Algebraic Type System.
/// A **data format** that can deserialize any data structure supported by SATS.
///
/// The `Deserializer` trait in SATS performs the same function as [`serde::Deserializer`] in [`serde`].
/// See the documentation of [`serde::Deserializer`] for more information of the data model.
Expand All @@ -28,9 +27,6 @@ use std::borrow::Borrow;
///
/// The lifetime `'de` allows us to deserialize lifetime-generic types in a zero-copy fashion.
///
/// Do not manually implement this trait unless you know what you are doing.
/// Incorrect implementations are safe, but can result in data loss.
///
/// [`serde::Deserializer`]: ::serde::Deserializer
/// [`serde`]: https://crates.io/crates/serde
pub trait Deserializer<'de>: Sized {
Expand Down Expand Up @@ -546,7 +542,7 @@ pub trait DeserializeSeed<'de> {
use crate::de::impls::BorrowedSliceVisitor;
pub use spacetimedb_bindings_macro::Deserialize;

/// A **datastructure** that can be deserialized from any data format supported by SATS.
/// A **data structure** that can be deserialized from any data format supported by the SpacetimeDB Algebraic Type System.
///
/// In most cases, implementations of `Deserialize` may be `#[derive(Deserialize)]`d.
///
Expand All @@ -555,6 +551,9 @@ pub use spacetimedb_bindings_macro::Deserialize;
///
/// The lifetime `'de` allows us to deserialize lifetime-generic types in a zero-copy fashion.
///
/// Do not manually implement this trait unless you know what you are doing.
/// Incorrect implementations are safe, but can result in data loss.
///
/// [`serde::Deserialize`]: ::serde::Deserialize
/// [`serde`]: https://crates.io/crates/serde
pub trait Deserialize<'de>: Sized {
Expand Down

0 comments on commit 6137dc2

Please sign in to comment.