💥 Future-proof UnsupportedTerminal error

Author: bash

crates/benchmark/src/main.rs

@@ -42,7 +42,7 @@ fn main() -> Result<()> {
 
     let supported = match color_palette(QueryOptions::default()) {
         Ok(_) => true,
-        Err(Error::UnsupportedTerminal) => false,
+        Err(Error::UnsupportedTerminal(_)) => false,
         Err(e) => return Err(e),
     };
 
@@ -54,7 +54,7 @@ fn main() -> Result<()> {
 fn bench() -> Result<Duration> {
     let start = Instant::now();
     match black_box(color_palette(QueryOptions::default())) {
-        Ok(_) | Err(Error::UnsupportedTerminal) => Ok(start.elapsed()),
+        Ok(_) | Err(Error::UnsupportedTerminal(_)) => Ok(start.elapsed()),
         Err(err) => Err(err),
     }
 }

crates/terminal-colorsaurus/src/error.rs

@@ -19,14 +19,15 @@ pub enum Error {
     /// [`QueryOptions::require_terminal_on_stdout`]: `crate::QueryOptions::require_terminal_on_stdout`
     NotATerminal(NotATerminalError),
     /// The terminal does not support querying for the foreground or background color.
-    UnsupportedTerminal,
+    UnsupportedTerminal(UnsupportedTerminalError),
 }
 
 impl error::Error for Error {
     fn source(&self) -> Option<&(dyn error::Error + 'static)> {
         match self {
             Error::Io(source) => Some(source),
             Error::NotATerminal(source) => Some(source),
+            Error::UnsupportedTerminal(source) => Some(source),
             _ => None,
         }
     }
@@ -47,9 +48,7 @@ impl fmt::Display for Error {
                 write!(f, "operation did not complete within {timeout:?}")
             }
             Error::NotATerminal(e) => fmt::Display::fmt(e, f),
-            Error::UnsupportedTerminal {} => {
-                write!(f, "the terminal does not support querying for its colors")
-            }
+            Error::UnsupportedTerminal(e) => fmt::Display::fmt(e, f),
         }
     }
 }
@@ -60,6 +59,12 @@ impl From<io::Error> for Error {
     }
 }
 
+impl Error {
+    pub(crate) fn unsupported() -> Self {
+        Error::UnsupportedTerminal(UnsupportedTerminalError)
+    }
+}
+
 #[derive(Debug)]
 #[non_exhaustive]
 pub struct NotATerminalError;
@@ -68,6 +73,18 @@ impl error::Error for NotATerminalError {}
 
 impl fmt::Display for NotATerminalError {
     fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
-        write!(f, "stdout is not connected to a terminal")
+        f.write_str("stdout is not connected to a terminal")
+    }
+}
+
+#[derive(Debug)]
+#[non_exhaustive]
+pub struct UnsupportedTerminalError;
+
+impl error::Error for UnsupportedTerminalError {}
+
+impl fmt::Display for UnsupportedTerminalError {
+    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+        f.write_str("the terminal does not support querying for its colors")
     }
 }

crates/terminal-colorsaurus/src/unsupported.rs

@@ -1,13 +1,13 @@
 use crate::{Color, ColorPalette, Error, QueryOptions, Result};
 
 pub(crate) fn color_palette(_options: QueryOptions) -> Result<ColorPalette> {
-    Err(Error::UnsupportedTerminal)
+    Err(Error::unsupported())
 }
 
 pub(crate) fn foreground_color(_options: QueryOptions) -> Result<Color> {
-    Err(Error::UnsupportedTerminal)
+    Err(Error::unsupported())
 }
 
 pub(crate) fn background_color(_options: QueryOptions) -> Result<Color> {
-    Err(Error::UnsupportedTerminal)
+    Err(Error::unsupported())
 }

crates/terminal-colorsaurus/src/xterm.rs

@@ -105,7 +105,7 @@ fn query<T>(
     ensure_is_terminal(options.require_terminal_on_stdout)?;
 
     if quirks.is_known_unsupported() {
-        return Err(Error::UnsupportedTerminal);
+        return Err(Error::unsupported());
     }
 
     let mut tty = terminal()?;
@@ -143,7 +143,7 @@ fn read_color_response(r: &mut Reader<'_>) -> Result<Vec<u8>> {
     // the terminal does not recocgnize the color query.
     if !r.buffer().starts_with(b"]") {
         _ = consume_da1_response(r, false);
-        return Err(Error::UnsupportedTerminal);
+        return Err(Error::unsupported());
     }
 
     // Some terminals always respond with BEL (see terminal survey).