Drop-OSS/archived-native-model
1
0
Fork 0
mirror of https://github.com/Drop-OSS/native_model.git synced 2026-01-30 20:55:19 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: simplified docs on codecs

Browse Source
This commit is contained in:
Dylan Bowker
2024-05-12 14:43:51 -06:00
committed by Vincent Herlemont
parent 6004a6fbd7
commit 1262c6b9ea
4 changed files with 20 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/codec/bincode_1_3.rs
View File

@@ -1,9 +1,9 @@
//! ⚠️ [`Read the docs before using`](crate::bincode_1_3::Bincode#warning) -
//! Annotate your type with `native_model::bincode_1_3::Bincode` to have
//! `native_db` use the bincode 1.3 crate for serializing & deserializing.
//! [bincode 1.3](https://crates.io/crates/bincode/1.3.3) ·
//! The default codec for serializing & deserializing.
/// Used to specify the [bincode](https://crates.io/crates/bincode/1.3.3) `1.3`
/// crate for serialization & deserialization.
/// Used to specify that the
/// [bincode 1.3](https://crates.io/crates/bincode/1.3.3) crate is to be used
/// for serialization & deserialization.
///
/// # Warning
///

11
src/codec/bincode_2_rc.rs
View File

@@ -1,10 +1,11 @@
//! ⚠️ [`Read the docs before using`](crate::bincode_2_rc::Bincode#warning) -
//! [bincode 2.0.0-rc.3](https://crates.io/crates/bincode/2.0.0-rc.3) ·
//! Enable the `bincode_2_rc` feature and annotate your type with
//! `native_model::bincode_2_rc::Bincode` to have `native_db` use the bincode
//! 2.0.0-rc.3 crate for serializing & deserializing.
//! `native_model::bincode_2_rc::Bincode` to have `native_db` use this crate for
//! serializing & deserializing.
/// Used to specify the [bincode](https://crates.io/crates/bincode/2.0.0-rc.3)
/// `2.0.0-rc.3` crate for serialization & deserialization.
/// Used to specify the
/// [bincode 2.0.0-rc.3](https://crates.io/crates/bincode/2.0.0-rc.3)
/// crate for serialization & deserialization.
///
/// # Warning
///

9
src/codec/postcard_1_0.rs
View File

@@ -1,10 +1,9 @@
//! ⚠️ [`Read the docs before using`](crate::postcard_1_0::PostCard#warning) -
//! [postcard 1.0](https://crates.io/crates/postcard/1.0.8) ·
//! Enable the `postcard_1_0` feature and annotate your type with
//! `native_model::postcard_1_0::PostCard` to have `native_db` use the postcard
//! 1.0 crate for serializing & deserializing.
//! `native_model::postcard_1_0::PostCard` to have `native_db` use this crate.
/// Used to specify the [postcard](https://crates.io/crates/postcard/1.0.8)
/// `1.0` crate for serialization & deserialization.
/// Used to specify the [postcard 1.0](https://crates.io/crates/postcard/1.0.8)
/// crate for serialization & deserialization.
///
/// # Warning
///

9
src/codec/rmp_serde_1_3.rs
View File

@@ -1,10 +1,11 @@
//! [rmp-serde 1.3](https://crates.io/crates/rmp-serde/1.3.0) ·
//! Enable the `rmp_serde_1_3` feature and
//! [`annotate your type`](crate::native_model) with
//! `native_model::rmp_serde_1_3::RmpSerde` to have `native_db` use the
//! rmp-serde 1.3 crate for serializing & deserializing.
//! `native_model::rmp_serde_1_3::RmpSerde` to have `native_db` use this crate.
/// Used to specify the [rmp-serde](https://crates.io/crates/rmp-serde/1.3.0)
/// `1.3` crate for serialization & deserialization.
/// Used to specify the
/// [rmp-serde 1.3](https://crates.io/crates/rmp-serde/1.3.0)
/// crate for serialization & deserialization.
///
/// # Basic usage
///