Add buck2_error::Error conversion for superconsole::SpanError

Summary:
Seeing a lot of errors come from SpanError -> anyhow::Error -> buck2_error tagged with ErrorTag::Tier0, and I'm trying to reduce usage of ErrorTag::Tier0.

These don't need to be converted to anyhow in the superconsole crate, keeping them as SpanError let's us convert directly into buck2_error with `From` to specify a tag in one place and clean up a bunch of code.

The downside is making buck2_error depend on superconsole, if needed we could introduce a superconsole_error crate later (possibly along with adding structured errors for `draw` methods).

Reviewed By: JakobDegen

Differential Revision: D72018086

fbshipit-source-id: 996bdb5092202b37baea332378f13f43c6e000e6

Author: christolliday

src/content.rs

@@ -12,6 +12,7 @@
 pub use line::Line;
 pub use lines::Lines;
 pub use span::Span;
+pub use span::SpanError;
 
 mod line;
 mod lines;

src/content/line.rs

@@ -24,6 +24,7 @@ use unicode_segmentation::UnicodeSegmentation;
 
 use crate::vec_as_fmt_write::VecAsFmtWrite;
 use crate::Span;
+use crate::SpanError;
 
 /// A `Line` is an abstraction for a collection of stylized or unstylized strings.
 /// Since each `Span` denotes a portion of a single line, an ordered collection represents a single line of text.
@@ -36,7 +37,7 @@ pub struct Line(
 );
 
 impl Line {
-    pub fn unstyled(text: &str) -> anyhow::Result<Line> {
+    pub fn unstyled(text: &str) -> Result<Line, SpanError> {
         Ok(Line::from_iter([Span::new_unstyled(text)?]))
     }
 
@@ -240,24 +241,24 @@ impl FromIterator<Span> for Line {
 }
 
 impl TryFrom<Vec<String>> for Line {
-    type Error = anyhow::Error;
+    type Error = SpanError;
 
     fn try_from(other: Vec<String>) -> Result<Self, Self::Error> {
         other
             .into_iter()
             .map(Span::new_unstyled)
-            .collect::<anyhow::Result<Line>>()
+            .collect::<Result<Line, SpanError>>()
     }
 }
 
 impl TryFrom<Vec<&str>> for Line {
-    type Error = anyhow::Error;
+    type Error = SpanError;
 
     fn try_from(other: Vec<&str>) -> Result<Self, Self::Error> {
         other
             .into_iter()
             .map(Span::new_unstyled)
-            .collect::<anyhow::Result<Line>>()
+            .collect::<Result<Line, SpanError>>()
     }
 }
 
@@ -360,7 +361,7 @@ mod tests {
 
     #[test]
     fn test_trim_ends() -> anyhow::Result<()> {
-        let line = |spans: &[&str]| -> anyhow::Result<Line> { spans.to_vec().try_into() };
+        let line = |spans: &[&str]| -> Result<Line, SpanError> { spans.to_vec().try_into() };
         let mut test = line(&["hello", "cat", "world"])?;
         test.trim_ends(0, 15);
         assert_eq!(test, line(&["hello", "cat", "world"])?);

src/content/span.rs

@@ -27,7 +27,7 @@ use unicode_segmentation::Graphemes;
 use unicode_segmentation::UnicodeSegmentation;
 
 #[derive(Debug, thiserror::Error)]
-enum SpanError {
+pub enum SpanError {
     #[error("Word {0} contains non-space whitespace")]
     InvalidWhitespace(String),
 }
@@ -102,7 +102,7 @@ impl Span {
 
     /// Attempt to create a new, unstyled span equivalent to the underlying stringlike.
     /// This will fail if the input string is not [`valid`](Span::valid).
-    pub fn new_unstyled<S: std::fmt::Display>(stringlike: S) -> anyhow::Result<Self> {
+    pub fn new_unstyled<S: std::fmt::Display>(stringlike: S) -> Result<Self, SpanError> {
         let owned = stringlike.to_string();
         if Self::valid(&owned) {
             Ok(Self {
@@ -111,7 +111,7 @@ impl Span {
                 hyperlink: None,
             })
         } else {
-            Err(SpanError::InvalidWhitespace(owned).into())
+            Err(SpanError::InvalidWhitespace(owned))
         }
     }
 
@@ -126,15 +126,15 @@ impl Span {
 
     /// Equivalent to [`new_unstyled`](Span::new_unstyled), except with styling.
     // TODO(brasselsprouts): Does this have to be a `String`? probably not.
-    pub fn new_styled(content: StyledContent<String>) -> anyhow::Result<Self> {
+    pub fn new_styled(content: StyledContent<String>) -> Result<Self, SpanError> {
         if Self::valid(content.content()) {
             Ok(Self {
                 content: Cow::Owned(content.content().clone()),
                 style: *content.style(),
                 hyperlink: None,
             })
         } else {
-            Err(SpanError::InvalidWhitespace(content.content().to_owned()).into())
+            Err(SpanError::InvalidWhitespace(content.content().to_owned()))
         }
     }
 
@@ -148,7 +148,7 @@ impl Span {
         }
     }
 
-    pub fn new_colored(text: &str, color: Color) -> anyhow::Result<Self> {
+    pub fn new_colored(text: &str, color: Color) -> Result<Self, SpanError> {
         Self::new_styled(StyledContent::new(
             ContentStyle {
                 foreground_color: Some(color),
@@ -328,23 +328,23 @@ impl Span {
 }
 
 impl TryFrom<String> for Span {
-    type Error = anyhow::Error;
+    type Error = SpanError;
 
     fn try_from(value: String) -> Result<Self, Self::Error> {
         Self::new_unstyled(value)
     }
 }
 
 impl TryFrom<&str> for Span {
-    type Error = anyhow::Error;
+    type Error = SpanError;
 
     fn try_from(value: &str) -> Result<Self, Self::Error> {
         Self::new_unstyled(value)
     }
 }
 
 impl TryFrom<StyledContent<String>> for Span {
-    type Error = anyhow::Error;
+    type Error = SpanError;
 
     fn try_from(value: StyledContent<String>) -> Result<Self, Self::Error> {
         Self::new_styled(value)

src/lib.rs

@@ -29,6 +29,7 @@ pub use components::DrawMode;
 pub use content::Line;
 pub use content::Lines;
 pub use content::Span;
+pub use content::SpanError;
 pub use dimensions::Dimensions;
 pub use dimensions::Direction;