Merge pull request #460 from lmbollen/ufmt-udisplay-string

Add `uDisplay` for `String` and inline `ufmt` functions

Author: Dirbaio

CHANGELOG.md

@@ -43,6 +43,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - Implemented `PartialEq` and `Eq` for `Deque`.
 - Added `truncate` to `IndexMap`.
 - Added `get_index` and `get_index_mut` to `IndexMap`.
+- Added `String::uDisplay`.
 
 ### Changed
 
@@ -110,6 +111,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   - `ufmt-impl` is now `ufmt`
   - `cas` is removed, atomic polyfilling is now opt-in via the `portable-atomic` feature.
 - `Vec::as_mut_slice` is now a public method.
+- `ufmt` functions are annotated with `inline`.
 
 ### Fixed
 

Cargo.toml

@@ -31,7 +31,7 @@ portable-atomic-unsafe-assume-single-core = ["dep:portable-atomic", "portable-at
 serde = ["dep:serde"]
 
 # implement ufmt traits.
-ufmt = ["dep:ufmt-write"]
+ufmt = ["dep:ufmt", "dep:ufmt-write"]
 
 # Implement `defmt::Format`.
 defmt = ["dep:defmt"]
@@ -45,6 +45,7 @@ nightly = []
 portable-atomic = { version = "1.0", optional = true }
 hash32 = "0.3.0"
 serde = { version = "1", optional = true, default-features = false }
+ufmt = { version = "0.2", optional = true }
 ufmt-write = { version = "0.1", optional = true }
 defmt = { version = "1.0.1", optional = true }
 
@@ -53,7 +54,6 @@ defmt = { version = "1.0.1", optional = true }
 stable_deref_trait = { version = "1", default-features = false }
 
 [dev-dependencies]
-ufmt = "0.2"
 static_assertions = "1.1.0"
 
 [package.metadata.docs.rs]

src/ufmt.rs

@@ -3,17 +3,30 @@ use crate::{
     vec::{VecInner, VecStorage},
     CapacityError,
 };
+use ufmt::uDisplay;
 use ufmt_write::uWrite;
 
+impl<S: StringStorage + ?Sized> uDisplay for StringInner<S> {
+    #[inline]
+    fn fmt<W>(&self, f: &mut ufmt::Formatter<'_, W>) -> Result<(), W::Error>
+    where
+        W: uWrite + ?Sized,
+    {
+        f.write_str(&self.as_str())
+    }
+}
+
 impl<S: StringStorage + ?Sized> uWrite for StringInner<S> {
     type Error = CapacityError;
+    #[inline]
     fn write_str(&mut self, s: &str) -> Result<(), Self::Error> {
         self.push_str(s)
     }
 }
 
 impl<S: VecStorage<u8> + ?Sized> uWrite for VecInner<u8, S> {
     type Error = CapacityError;
+    #[inline]
     fn write_str(&mut self, s: &str) -> Result<(), Self::Error> {
         self.extend_from_slice(s.as_bytes())
     }
@@ -32,7 +45,16 @@ mod tests {
     }
 
     #[test]
-    fn test_string() {
+    fn test_udisplay_string() {
+        let str_a = String::<32>::try_from("world").unwrap();
+        let mut str_b = String::<32>::new();
+        uwrite!(str_b, "Hello {}!", str_a).unwrap();
+
+        assert_eq!(str_b, "Hello world!");
+    }
+
+    #[test]
+    fn test_uwrite_string() {
         let a = 123;
         let b = Pair { x: 0, y: 1234 };
 
@@ -43,14 +65,14 @@ mod tests {
     }
 
     #[test]
-    fn test_string_err() {
+    fn test_uwrite_string_err() {
         let p = Pair { x: 0, y: 1234 };
         let mut s = String::<4>::new();
         assert!(uwrite!(s, "{:?}", p).is_err());
     }
 
     #[test]
-    fn test_vec() {
+    fn test_uwrite_vec() {
         let a = 123;
         let b = Pair { x: 0, y: 1234 };