encode: implement Display for EncodeBuilder

Add implementation of core::fmt::Display for EncodeBuilder which tries
to avoid memory allocations when encoding sensibly small values
(specifically, shorter than 96 bytes).

Author: mina86

src/encode.rs

@@ -328,7 +328,12 @@ impl<'a, I: AsRef<[u8]>> EncodeBuilder<'a, I> {
     /// assert_eq!("he11owor1d\0ld", output);
     /// # Ok::<(), bs58::encode::Error>(())
     /// ```
-    pub fn into(self, mut output: impl EncodeTarget) -> Result<usize> {
+    pub fn into(self, output: impl EncodeTarget) -> Result<usize> {
+        self.to(output)
+    }
+
+    /// Same as [`Self::into`] but does not consume `self`.
+    fn to(&self, mut output: impl EncodeTarget) -> Result<usize> {
         let input = self.input.as_ref();
         match self.check {
             Check::Disabled => output.encode_with(max_encoded_len(input.len()), |output| {
@@ -352,11 +357,41 @@ impl<'a, I: AsRef<[u8]>> EncodeBuilder<'a, I> {
     }
 }
 
+#[cfg(feature = "alloc")]
+impl<'a, I: AsRef<[u8]>> core::fmt::Display for EncodeBuilder<'a, I> {
+    fn fmt(&self, fmt: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
+        // If input is short enough, encode it into a buffer on stack to avoid
+        // allocation.  96 bytes length limit should be plenty and cover all
+        // sane cases; base58 is typically used for things like encryption keys
+        // and hashes which are often no more than 32-bytes long.
+        const LEN_LIMIT: usize = 96;
+
+        #[cfg(any(feature = "check", feature = "cb58"))]
+        const MAX_LEN: usize = LEN_LIMIT + CHECKSUM_LEN + 1;
+        #[cfg(not(any(feature = "check", feature = "cb58")))]
+        const MAX_LEN: usize = LEN_LIMIT;
+        let mut buf = [0u8; max_encoded_len(MAX_LEN)];
+        let mut vec = Vec::new();
+
+        let output = if self.input.as_ref().len() <= LEN_LIMIT {
+            let len = self.to(&mut buf[..]).unwrap();
+            &buf[..len]
+        } else {
+            self.to(&mut vec).unwrap();
+            vec.as_slice()
+        };
+
+        // SAFETY: we know that alphabet can only include ASCII characters
+        // thus our result is an ASCII string.
+        fmt.write_str(unsafe { std::str::from_utf8_unchecked(output) })
+    }
+}
+
 /// Return maximum possible encoded length of a buffer with given length.
 ///
 /// Assumes that the `len` already includes version and checksum bytes if those
-/// are
-fn max_encoded_len(len: usize) -> usize {
+/// are part of the encoding.
+const fn max_encoded_len(len: usize) -> usize {
     // log_2(256) / log_2(58) ≈ 1.37.  Assume 1.5 for easier calculation.
     len + (len + 1) / 2
 }

tests/encode.rs

@@ -29,6 +29,10 @@ fn test_encode() {
             }
             assert_eq!(&FILLER[(s.len() + 1)..], &bytes[(s.len() + 1)..]);
         }
+
+        // Test Display implementation
+        assert_eq!(s, format!("{}", bs58::encode(val)));
+        assert_eq!(s, bs58::encode(val).to_string());
     }
 }