Add ufmt::uDisplay impl on ByteString

Author: Cryptjar

Cargo.toml

@@ -29,25 +29,31 @@ opt-level = "s"
 
 
 [features]
-default = ["lpm-asm-loop"]
+default = ["lpm-asm-loop", "ufmt"]
 # Enables the use of the `lpm r0, Z+` in an assembly loop, instead of the plain
 # `lpm` instruction with a Rust loop.
 lpm-asm-loop = []
 # Enables some tweak to ease debugging, should not be use in production
 dev = []
 
-# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
-
 [dependencies]
 cfg-if = "0.1.10"
 
+[dependencies.ufmt]
+version = "0.1.0"
+optional = true
+
 
 [dev-dependencies]
 panic-halt = "0.2.0"
 ufmt = "0.1.0"
 
+[dev-dependencies.void]
+version = "1.0"
+default-features = false
+
+
 [dev-dependencies.arduino-uno]
 # It is not yet available via crates.io
 git = "https://github.com/Rahix/avr-hal.git"
-rev = "0c6cf1675c2724354f1adeaeee69992acd371e80"
-
+rev = "0c6cf1675c2724354f1adeaeee69992acd371e80"

examples/printer/mod.rs

@@ -35,3 +35,27 @@ impl Printer {
 		print!("{}", c);
 	}
 }
+
+impl ufmt::uWrite for Printer {
+	type Error = void::Void;
+
+	fn write_str(&mut self, s: &str) -> Result<(), Self::Error> {
+		#[cfg(target_arch = "avr")]
+		ufmt::uwrite!(&mut self.0, "{}", s).void_unwrap();
+
+		#[cfg(not(target_arch = "avr"))]
+		println!("{}", s);
+
+		Ok(())
+	}
+
+	fn write_char(&mut self, c: char) -> Result<(), Self::Error> {
+		#[cfg(target_arch = "avr")]
+		ufmt::uwrite!(&mut self.0, "{}", c).void_unwrap();
+
+		#[cfg(not(target_arch = "avr"))]
+		print!("{}", c);
+
+		Ok(())
+	}
+}

examples/uno-string.rs

@@ -94,6 +94,10 @@ fn main() -> ! {
 	printer.println(avr_progmem::progmem_str!("Just a lone literal progmem str"));
 	printer.println(avr_progmem::progmem_str!("And another one"));
 
+	// Using the ufmt impl
+	#[cfg(feature = "ufmt")]
+	ufmt::uwriteln!(&mut printer, "{}\r", UNICODE_TEXT.load()).unwrap();
+
 	// Print some final lines
 	printer.println("");
 	printer.println("--------------------------");

src/lib.rs

@@ -8,6 +8,9 @@
 //
 // For string support, we need to convert from slice to array in const context.
 #![cfg_attr(not(doc), feature(const_raw_ptr_deref))]
+//
+// Allows to document required crate features on items
+#![feature(doc_cfg)]
 
 //!
 //! Progmem utilities for the AVR architectures.

src/string.rs

@@ -1,3 +1,4 @@
+use core::fmt;
 use core::ops::Deref;
 
 
@@ -84,6 +85,24 @@ impl<const N: usize> Deref for ByteString<N> {
 	}
 }
 
+impl<const N: usize> fmt::Display for ByteString<N> {
+	fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
+		write!(fmt, "{}", self.deref())
+	}
+}
+
+#[cfg(any(feature = "ufmt", doc))]
+#[doc(cfg(feature = "ufmt"))]
+impl<const N: usize> ufmt::uDisplay for ByteString<N> {
+	fn fmt<W: ?Sized>(&self, fmt: &mut ufmt::Formatter<W>) -> Result<(), W::Error>
+	where
+		W: ufmt::uWrite,
+	{
+		ufmt::uwrite!(fmt, "{}", self.deref())
+	}
+}
+
+
 /// Define a string in progmem
 ///
 /// This is a short-cut macro to create an ad-hoc static storing the given