reexport serde-related items

Author: crapStone

ciborium/src/lib.rs

@@ -6,12 +6,12 @@
 //!
 //! # Quick Start
 //!
-//! You're probably looking for [`de::from_reader()`](crate::de::from_reader)
-//! and [`ser::into_writer()`](crate::ser::into_writer), which are
+//! You're probably looking for [`from_reader()`](crate::de::from_reader)
+//! and [`into_writer()`](crate::ser::into_writer), which are
 //! the main functions. Note that byte slices are also readers and writers and can be
 //! passed to these functions just as streams can.
 //!
-//! For dynamic CBOR value creation/inspection, see [`value::Value`](crate::value::Value).
+//! For dynamic CBOR value creation/inspection, see [`Value`](crate::value::Value).
 //!
 //! # Design Decisions
 //!
@@ -97,6 +97,16 @@ pub mod ser;
 pub mod tag;
 pub mod value;
 
+// Re-export the [items recommended by serde](https://serde.rs/conventions.html).
+#[doc(inline)]
+pub use crate::de::from_reader;
+
+#[doc(inline)]
+pub use crate::ser::into_writer;
+
+#[doc(inline)]
+pub use crate::value::Value;
+
 /// Build a `Value` conveniently.
 ///
 /// The syntax should be intuitive if you are familiar with JSON. You can also

ciborium/src/value/mod.rs

@@ -49,7 +49,7 @@ impl Value {
     /// Returns true if the `Value` is an `Integer`. Returns false otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Integer(17.into());
     ///
@@ -63,7 +63,7 @@ impl Value {
     /// Returns None otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Integer(17.into());
     ///
@@ -80,7 +80,7 @@ impl Value {
     /// Returns true if the `Value` is a `Bytes`. Returns false otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Bytes(vec![104, 101, 108, 108, 111]);
     ///
@@ -94,7 +94,7 @@ impl Value {
     /// Returns None otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Bytes(vec![104, 101, 108, 108, 111]);
     ///
@@ -111,7 +111,7 @@ impl Value {
     /// Returns None otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let mut value = Value::Bytes(vec![104, 101, 108, 108, 111]);
     /// value.as_bytes_mut().unwrap().clear();
@@ -128,7 +128,7 @@ impl Value {
     /// Returns true if the `Value` is a `Float`. Returns false otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Float(17.0.into());
     ///
@@ -142,7 +142,7 @@ impl Value {
     /// Returns None otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Float(17.0.into());
     ///
@@ -159,7 +159,7 @@ impl Value {
     /// Returns true if the `Value` is a `Text`. Returns false otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Text(String::from("hello"));
     ///
@@ -173,7 +173,7 @@ impl Value {
     /// Returns None otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Text(String::from("hello"));
     ///
@@ -191,7 +191,7 @@ impl Value {
     /// Returns None otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let mut value = Value::Text(String::from("hello"));
     /// value.as_text_mut().unwrap().clear();
@@ -208,7 +208,7 @@ impl Value {
     /// Returns true if the `Value` is a `Bool`. Returns false otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Bool(false);
     ///
@@ -222,7 +222,7 @@ impl Value {
     /// otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Bool(false);
     ///
@@ -238,7 +238,7 @@ impl Value {
     /// Returns true if the `Value` is a `Null`. Returns false otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Null;
     ///
@@ -251,7 +251,7 @@ impl Value {
     /// Returns true if the `Value` is a `Tag`. Returns false otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Tag(61, Box::from(Value::Null));
     ///
@@ -265,7 +265,7 @@ impl Value {
     /// Returns None otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Tag(61, Box::from(Value::Bytes(vec![104, 101, 108, 108, 111])));
     ///
@@ -284,7 +284,7 @@ impl Value {
     /// to the tag `Value`. Returns None otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let mut value = Value::Tag(61, Box::from(Value::Bytes(vec![104, 101, 108, 108, 111])));
     ///
@@ -303,7 +303,7 @@ impl Value {
     /// Returns true if the `Value` is an Array. Returns false otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Array(
     ///     vec![
@@ -322,7 +322,7 @@ impl Value {
     /// otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Array(
     ///     vec![
@@ -345,7 +345,7 @@ impl Value {
     /// Returns None otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let mut value = Value::Array(
     ///     vec![
@@ -367,7 +367,7 @@ impl Value {
     /// Returns true if the `Value` is a Map. Returns false otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Map(
     ///     vec![
@@ -385,7 +385,7 @@ impl Value {
     /// otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let value = Value::Map(
     ///     vec![
@@ -413,7 +413,7 @@ impl Value {
     /// Returns None otherwise.
     ///
     /// ```
-    /// # use ciborium::value::Value;
+    /// # use ciborium::Value;
     /// #
     /// let mut value = Value::Map(
     ///     vec![