Ryan/drop
1
0
Fork 0
mirror of https://github.com/Drop-OSS/drop.git synced 2026-07-25 01:13:39 +10:00
Code Issues Packages Projects Releases Wiki Activity

docs: update to docs on codecs

Browse Source
This commit is contained in:
Dylan Bowker
2024-05-12 14:19:52 -06:00
committed by Vincent Herlemont
parent ac150841b0
commit b85d4ce554
1 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libraries/native_model/src/lib.rs
+8 -6
View File
@@ -20,21 +20,22 @@
//! `native_model` comes with several optional built-in serializer features //! `native_model` comes with several optional built-in serializer features
//! available: //! available:
//! //!
//! - [bincode](https://crates.io/crates/bincode/1.3.3) `1.3` · This is the //! - [bincode 1.3](https://crates.io/crates/bincode/1.3.3) · This is the
//! default codec. **Warning: This codec may not work with all serde-derived //! default codec. **Warning: This codec may not work with all serde-derived
//! types.** //! types.**
//! //!
//! - [bincode](https://crates.io/crates/bincode/2.0.0-rc.3) `2.0.0-rc.3` · //! - [bincode 2.0.0-rc.3](https://crates.io/crates/bincode/2.0.0-rc.3) ·
//! Enable the `bincode_2_rc` feature and use the //! Enable the `bincode_2_rc` feature and use the
//! `native_model::bincode_2_rc::Bincode` attribute to have `native_db` use this //! `native_model::bincode_2_rc::Bincode` attribute to have `native_db` use this
//! crate. **Warning: This codec may not work with all serde-derived types.** //! crate for serializing & deserializing. **Warning: This codec may not work
//! with all serde-derived types.**
//! //!
//! - [postcard](https://crates.io/crates/postcard/1.0.8) `1.0` · //! - [postcard 1.0](https://crates.io/crates/postcard/1.0.8) ·
//! Enable the `postcard_1_0` feature and use the //! Enable the `postcard_1_0` feature and use the
//! `native_model::postcard_1_0::PostCard` attribute. **Warning: This codec may //! `native_model::postcard_1_0::PostCard` attribute. **Warning: This codec may
//! not work with all serde-derived types.** //! not work with all serde-derived types.**
//! //!
//! - [rmp-serde](https://crates.io/crates/rmp-serde/1.3.0) `1.3` · //! - [rmp-serde 1.3](https://crates.io/crates/rmp-serde/1.3.0) ·
//! Enable the `rmp_serde_1_3` feature and use the //! Enable the `rmp_serde_1_3` feature and use the
//! `native_model::rmp_serde_1_3::RmpSerde` attribute. //! `native_model::rmp_serde_1_3::RmpSerde` attribute.
//! //!
@@ -53,7 +54,8 @@
//! native_model = { version = "0.4", features = [ "rmp_serde_1_3" ] } //! native_model = { version = "0.4", features = [ "rmp_serde_1_3" ] }
//! ``` //! ```
//! //!
//! 2. Assign the `rmp_serde_1_3` codec to your type using the `with` attribute: //! 2. Assign the `rmp_serde_1_3` codec to your `struct` using the `with`
//! attribute:
//! //!
//! ```rust //! ```rust
//! #[derive(Clone, Default, serde::Deserialize, serde::Serialize)] //! #[derive(Clone, Default, serde::Deserialize, serde::Serialize)]