Add an example for using color codes in prompt

murarth · Jun 1, 2018 · 8b125e2 · 8b125e2
1 parent 442ce8d
commit 8b125e2
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 0 deletions.
diff --git a/Cargo.toml b/Cargo.toml
@@ -26,5 +26,6 @@ winapi = { version = "0.3", features = [
     "winerror", "winuser" ] }
 
 [dev-dependencies]
+ansi_term = "0.11"
 assert_matches = "1.2"
 rand = "0.5"
diff --git a/examples/color_prompt.rs b/examples/color_prompt.rs
@@ -0,0 +1,35 @@
+//! Demonstrates how to use color escape sequences in the prompt string,
+//! using the `ansi_term` crate.
+
+extern crate ansi_term;
+extern crate linefeed;
+
+use std::io;
+
+use ansi_term::Color;
+
+use linefeed::{Interface, ReadResult};
+
+fn main() -> io::Result<()> {
+    let interface = Interface::new("color-demo")?;
+
+    let style = Color::Red.bold();
+    let text = "color-demo> ";
+
+    // The character values '\x01' and '\x02' are used to indicate the beginning
+    // and end of an escape sequence. This informs linefeed, which cannot itself
+    // interpret the meaning of escape sequences, that these characters are not
+    // visible when the prompt is drawn and should not factor into calculating
+    // the visible length of the prompt string.
+    interface.set_prompt(&format!("\x01{prefix}\x02{text}\x01{suffix}\x02",
+        prefix=style.prefix(),
+        text=text,
+        suffix=style.suffix()))?;
+
+    while let ReadResult::Input(line) = interface.read_line()? {
+        println!("read input: {:?}", line);
+        interface.add_history_unique(line);
+    }
+
+    Ok(())
+}