Update examples

rkyv · Mar 31, 2023 · 1909e6a · 1909e6a
1 parent d6b1310
commit 1909e6a
Show file tree

Hide file tree

Showing 4 changed files with 40 additions and 22 deletions.
diff --git a/README.md b/README.md
@@ -53,14 +53,18 @@
 
 ```rust
 use rkyv::{Archive, Deserialize, Serialize};
-// bytecheck can be used to validate your data if you want
-use bytecheck::CheckBytes;
 
 #[derive(Archive, Deserialize, Serialize, Debug, PartialEq)]
-// This will generate a PartialEq impl between our unarchived and archived types
-#[archive(compare(PartialEq))]
-// To use the safe API, you have to derive CheckBytes for the archived type
-#[archive_attr(derive(CheckBytes, Debug))]
+#[archive(
+    // This will generate a PartialEq impl between our unarchived and archived
+    // types:
+    compare(PartialEq),
+    // bytecheck can be used to validate your data if you want. To use the safe
+    // API, you have to derive CheckBytes for the archived type:
+    check_bytes,
+)]
+// Derives can be passed through to the generated type:
+#[archive_attr(derive(Debug))]
 struct Test {
     int: u8,
     string: String,

diff --git a/rkyv/README.md b/rkyv/README.md
@@ -53,14 +53,18 @@
 
 ```rust
 use rkyv::{Archive, Deserialize, Serialize};
-// bytecheck can be used to validate your data if you want
-use bytecheck::CheckBytes;
 
 #[derive(Archive, Deserialize, Serialize, Debug, PartialEq)]
-// This will generate a PartialEq impl between our unarchived and archived types
-#[archive(compare(PartialEq))]
-// To use the safe API, you have to derive CheckBytes for the archived type
-#[archive_attr(derive(CheckBytes, Debug))]
+#[archive(
+    // This will generate a PartialEq impl between our unarchived and archived
+    // types:
+    compare(PartialEq),
+    // bytecheck can be used to validate your data if you want. To use the safe
+    // API, you have to derive CheckBytes for the archived type:
+    check_bytes,
+)]
+// Derives can be passed through to the generated type:
+#[archive_attr(derive(Debug))]
 struct Test {
     int: u8,
     string: String,

diff --git a/rkyv/crates-io.md b/rkyv/crates-io.md
@@ -53,14 +53,18 @@
 
 ```rust
 use rkyv::{Archive, Deserialize, Serialize};
-// bytecheck can be used to validate your data if you want
-use bytecheck::CheckBytes;
 
 #[derive(Archive, Deserialize, Serialize, Debug, PartialEq)]
-// This will generate a PartialEq impl between our unarchived and archived types
-#[archive(compare(PartialEq))]
-// To use the safe API, you have to derive CheckBytes for the archived type
-#[archive_attr(derive(CheckBytes, Debug))]
+#[archive(
+    // This will generate a PartialEq impl between our unarchived and archived
+    // types:
+    compare(PartialEq),
+    // bytecheck can be used to validate your data if you want. To use the safe
+    // API, you have to derive CheckBytes for the archived type:
+    check_bytes,
+)]
+// Derives can be passed through to the generated type:
+#[archive_attr(derive(Debug))]
 struct Test {
     int: u8,
     string: String,

diff --git a/rkyv_test/src/test_alloc.rs b/rkyv_test/src/test_alloc.rs
@@ -106,13 +106,19 @@ mod tests {
         #[allow(unused_variables)]
         #[cfg_attr(feature = "wasm", wasm_bindgen_test)]
         fn archive_example() {
-            // CheckBytes from bytecheck can be used to validate your data, if you want
             use rkyv::{Archive, Deserialize, Serialize};
 
             #[derive(Archive, Deserialize, Serialize, Debug, PartialEq)]
-            // This will generate a PartialEq impl between our unarchived and archived types
-            // To use the safe API, you have to derive CheckBytes for the archived type
-            #[archive(check_bytes, compare(PartialEq))]
+            #[archive(
+                // This will generate a PartialEq impl between our unarchived
+                // and archived types:
+                compare(PartialEq),
+                // bytecheck can be used to validate your data if you want. To
+                // use the safe API, you have to derive CheckBytes for the
+                // archived type:
+                check_bytes,
+            )]
+            // Derives can be passed through to the generated type:
             #[archive_attr(derive(Debug))]
             struct Test {
                 int: u8,