Fix docs and doc tests

Author: DanikVitek

borsh/Cargo.toml

@@ -47,6 +47,7 @@ async-std = { version = "1", default-features = false, features = ["std"], optio
 
 [dev-dependencies]
 tokio-test = "0.4.4"
+tokio = { version = "1", features = ["io-std"] }
 insta = "1.29.0"
 serde_json = { version = "1" }
 

borsh/docs/rustdoc_include/borsh_crate_top_level.md

@@ -85,4 +85,6 @@ Following pages are highlighted here just to give reader a chance at learning th
 - [Derive Macro `BorshSerialize`](macro@crate::BorshSerialize)
 - [Derive Macro `BorshDeserialize`](macro@crate::BorshDeserialize)
 - [Derive Macro `BorshSchema`](macro@crate::BorshSchema)
+- [Derive Macro `BorshSerializeAsync`](macro@crate::BorshSerializeAsync)
+- [Derive Macro `BorshDeserializeAsync`](macro@crate::BorshDeserializeAsync)
 

borsh/src/de/mod.rs

@@ -1632,27 +1632,51 @@ pub fn from_slice<T: BorshDeserialize>(v: &[u8]) -> Result<T> {
 
 /// Deserializes an object from a reader.
 /// # Example
-/// ```
-/// use borsh::{BorshDeserialize, BorshSerialize, from_reader, to_vec};
-///
-/// /// derive is only available if borsh is built with `features = ["derive"]`
-/// # #[cfg(feature = "derive")]
-/// #[derive(BorshSerialize, BorshDeserialize, PartialEq, Debug)]
-/// struct MyStruct {
-///     a: u64,
-///     b: Vec<u8>,
-/// }
-///
-/// # #[cfg(feature = "derive")]
-/// let original = MyStruct { a: 10, b: vec![1, 2, 3] };
-/// # #[cfg(feature = "derive")]
-/// let encoded = to_vec(&original).unwrap();
-/// # #[cfg(feature = "derive")]
-/// let decoded = from_reader::<_, MyStruct>(&mut encoded.as_slice()).unwrap();
-/// # #[cfg(feature = "derive")]
-/// assert_eq!(original, decoded);
-/// ```
 #[async_generic(
+    /// ```
+    /// use borsh::{BorshDeserialize, BorshSerialize, from_reader, to_vec};
+    ///
+    /// /// derive is only available if borsh is built with `features = ["derive"]`
+    /// # #[cfg(feature = "derive")]
+    /// #[derive(BorshSerialize, BorshDeserialize, PartialEq, Debug)]
+    /// struct MyStruct {
+    ///     a: u64,
+    ///     b: Vec<u8>,
+    /// }
+    ///
+    /// # #[cfg(feature = "derive")]
+    /// let original = MyStruct { a: 10, b: vec![1, 2, 3] };
+    /// # #[cfg(feature = "derive")]
+    /// let encoded = to_vec(&original).unwrap();
+    /// # #[cfg(feature = "derive")]
+    /// let decoded = from_reader::<_, MyStruct>(&mut encoded.as_slice()).unwrap();
+    /// # #[cfg(feature = "derive")]
+    /// assert_eq!(original, decoded);
+    /// ```
+    sync_signature;
+
+    /// ```
+    /// use borsh::{BorshDeserializeAsync, BorshSerialize, from_reader_async, to_vec};
+    ///
+    /// /// derive is only available if borsh is built with `features = ["derive"]`
+    /// # #[cfg(feature = "derive")]
+    /// #[derive(BorshSerialize, BorshDeserializeAsync, PartialEq, Debug)]
+    /// struct MyStruct {
+    ///     a: u64,
+    ///     b: Vec<u8>,
+    /// }
+    ///
+    /// # tokio_test::block_on(async {
+    /// # #[cfg(feature = "derive")]
+    /// let original = MyStruct { a: 10, b: vec![1, 2, 3] };
+    /// # #[cfg(feature = "derive")]
+    /// let encoded = to_vec(&original).unwrap();
+    /// # #[cfg(feature = "derive")]
+    /// let decoded = from_reader_async::<_, MyStruct>(&mut encoded.as_slice()).await.unwrap();
+    /// # #[cfg(feature = "derive")]
+    /// assert_eq!(original, decoded);
+    /// # });
+    /// ```
     #[cfg(feature = "unstable__async")]
     async_signature[impl_fut]<R: AsyncRead, T: BorshDeserializeAsync>(
         reader: &mut R,

borsh/src/lib.rs

@@ -58,9 +58,9 @@ compile_error!(
 #[cfg(feature = "std")]
 use std::io as io_impl;
 
-/// Module is available if `borsh` is built with `features = ["unstable__async"]`.
-///
 /// Provides traits for async I/O operations.
+///
+/// Module is available if `borsh` is built with `features = ["unstable__async"]`.
 #[cfg(feature = "unstable__async")]
 pub mod async_io;
 

borsh/src/ser/helpers.rs

@@ -26,16 +26,25 @@ where
 }
 
 /// Serializes an object directly into a `Writer`.
-/// # Example
 ///
+/// # Example
 #[async_generic(
     /// ```
     /// # #[cfg(feature = "std")]
     /// let stderr = std::io::stderr();
     /// # #[cfg(feature = "std")]
-    /// assert_eq!((), borsh::to_writer(&stderr, "hello_0x0a").unwrap());
+    /// borsh::to_writer(&stderr, "hello_0x0a").unwrap();
     /// ```
     sync_signature;
+
+    /// ```
+    /// # tokio_test::block_on(async {
+    /// # #[cfg(feature = "unstable__tokio")]
+    /// let mut stderr = tokio::io::stderr();
+    /// # #[cfg(feature = "unstable__tokio")]
+    /// borsh::to_writer_async(&mut stderr, "hello_0x0a").await.unwrap();
+    /// # })
+    /// ```
     #[cfg(feature = "unstable__async")]
     async_signature<T, W: AsyncWrite>(mut writer: W, value: &T) -> Result<()>
     where