Clean up encoding methods

Author: udoprog

crates/musli/src/descriptive/encoding.rs

@@ -1,6 +1,3 @@
-//! Module that defines [`Encoding`] whith allows for customization of the
-//! encoding format, and the [`DEFAULT`] encoding configuration.
-
 use core::marker;
 
 #[cfg(feature = "alloc")]
@@ -25,6 +22,7 @@ use super::error::Error;
 /// [`variable length`]: https://en.wikipedia.org/wiki/Variable-length_quantity
 pub const OPTIONS: options::Options = options::new().build();
 
+#[allow(unused)]
 const DEFAULT: Encoding = Encoding::new();
 
 crate::macros::bare_encoding!(Binary, DEFAULT, descriptive, IntoReader, IntoWriter);

crates/musli/src/json/encoding.rs

@@ -1,6 +1,3 @@
-//! Module that defines [`Encoding`] whith allows for customization of the
-//! encoding format, and the [`DEFAULT`] encoding configuration.
-
 use core::marker;
 
 #[cfg(feature = "alloc")]
@@ -19,12 +16,12 @@ use super::en::JsonEncoder;
 use super::error::Error;
 use super::parser::IntoParser;
 
-/// The default encoding instance using the default [`OPTIONS`].
+#[allow(unused)]
 const DEFAULT: Encoding = Encoding::new();
 
 crate::macros::bare_encoding!(Text, DEFAULT, json, IntoParser, IntoWriter);
 
-/// Encode the given value to a [`String`] using the [`DEFAULT`] [`Encoding`].
+/// Encode the given value to a [`String`] using the default [`Encoding`].
 ///
 /// # Examples
 ///
@@ -59,7 +56,7 @@ where
     DEFAULT.to_string(value)
 }
 
-/// Decode the given type `T` from the given string using the [`DEFAULT`]
+/// Decode the given type `T` from the given string using the default
 /// [`Encoding`].
 ///
 /// # Examples

crates/musli/src/macros/internal.rs

@@ -2,7 +2,7 @@
 
 macro_rules! bare_encoding {
     ($mode:ident, $default:ident, $what:ident, $reader_trait:ident, $writer_trait:ident) => {
-        /// Encode the given value to the given [`Writer`] using the [`DEFAULT`]
+        /// Encode the given value to the given [`Writer`] using the default
         /// [`Encoding`].
         ///
         /// [`Writer`]: crate::Writer
@@ -43,7 +43,7 @@ macro_rules! bare_encoding {
             $default.encode(writer, value)
         }
 
-        /// Encode the given value to the given slice using the [`DEFAULT`]
+        /// Encode the given value to the given slice using the default
         /// [`Encoding`] and return the number of bytes encoded.
         ///
         /// # Examples
@@ -84,8 +84,7 @@ macro_rules! bare_encoding {
             $default.to_slice(out, value)
         }
 
-        /// Encode the given value to a [`Vec`] using the [`DEFAULT`]
-        /// [`Encoding`].
+        /// Encode the given value to a [`Vec`] using the default [`Encoding`].
         ///
         /// [`Vec`]: rust_alloc::vec::Vec
         ///
@@ -122,7 +121,7 @@ macro_rules! bare_encoding {
             $default.to_vec(value)
         }
 
-        /// Encode the given value to a fixed-size bytes using the [`DEFAULT`]
+        /// Encode the given value to a fixed-size bytes using the default
         /// [`Encoding`].
         ///
         /// ```
@@ -156,7 +155,7 @@ macro_rules! bare_encoding {
             $default.to_fixed_bytes::<N, _>(value)
         }
 
-        /// Encode the given value to the given [`Write`] using the [`DEFAULT`]
+        /// Encode the given value to the given [`Write`] using the default
         /// [`Encoding`].
         ///
         /// [`Write`]: std::io::Write
@@ -197,8 +196,8 @@ macro_rules! bare_encoding {
             $default.to_writer(writer, value)
         }
 
-        /// Decode the given type `T` from the given [`Reader`] using the [`DEFAULT`]
-        /// [`Encoding`].
+        /// Decode the given type `T` from the given [`Reader`] using the
+        /// default [`Encoding`].
         ///
         /// [`Reader`]: crate::Reader
         ///
@@ -243,7 +242,7 @@ macro_rules! bare_encoding {
             $default.decode(reader)
         }
 
-        /// Decode the given type `T` from the given slice using the [`DEFAULT`]
+        /// Decode the given type `T` from the given slice using the default
         /// [`Encoding`].
         ///
         /// # Examples

crates/musli/src/packed/encoding.rs

@@ -1,6 +1,3 @@
-//! Module that defines [`Encoding`] whith allows for customization of the
-//! encoding format, and the [`DEFAULT`] encoding configuration.
-
 use core::marker;
 
 #[cfg(feature = "alloc")]
@@ -17,6 +14,7 @@ use crate::storage::en::StorageEncoder;
 /// The default options for the packed encoding.
 pub const OPTIONS: Options = options::new().fixed().native_byte_order().build();
 
+#[allow(unused)]
 const DEFAULT: Encoding = Encoding::new();
 
 crate::macros::bare_encoding!(Binary, DEFAULT, packed, IntoReader, IntoWriter);

crates/musli/src/storage/encoding.rs

@@ -1,6 +1,3 @@
-//! Module that defines [`Encoding`] whith allows for customization of the
-//! encoding format, and the [`DEFAULT`] encoding configuration.
-
 use core::marker;
 
 #[cfg(feature = "alloc")]
@@ -25,6 +22,7 @@ use super::error::Error;
 /// [`variable length`]: https://en.wikipedia.org/wiki/Variable-length_quantity
 pub const OPTIONS: Options = options::new().build();
 
+#[allow(unused)]
 const DEFAULT: Encoding = Encoding::new();
 
 crate::macros::bare_encoding!(Binary, DEFAULT, storage, IntoReader, IntoWriter);

crates/musli/src/wire/encoding.rs

@@ -1,6 +1,3 @@
-//! Module that defines [`Encoding`] whith allows for customization of the
-//! encoding format, and the [`DEFAULT`] encoding configuration.
-
 use core::marker;
 
 #[cfg(feature = "alloc")]
@@ -25,6 +22,7 @@ use super::error::Error;
 /// [`variable length`]: https://en.wikipedia.org/wiki/Variable-length_quantity
 pub const OPTIONS: options::Options = options::new().build();
 
+#[allow(unused)]
 const DEFAULT: Encoding = Encoding::new();
 
 crate::macros::bare_encoding!(Binary, DEFAULT, wire, IntoReader, IntoWriter);