feat(stream): Initial support for auto-adapting streams

crates/anstyle-stream/Cargo.toml

@@ -11,6 +11,10 @@ edition.workspace = true
 rust-version.workspace = true
 include.workspace = true
 
+[package.metadata.docs.rs]
+rustdoc-args = ["--cfg", "docsrs"]
+cargo-args = ["-Zunstable-options", "-Zrustdoc-scrape-examples"]
+
 [package.metadata.release]
 pre-release-replacements = [
   {file="CHANGELOG.md", search="Unreleased", replace="{{version}}", min=1},
@@ -20,6 +24,23 @@ pre-release-replacements = [
   {file="CHANGELOG.md", search="<!-- next-url -->", replace="<!-- next-url -->\n[Unreleased]: https://github.com/rust-cli/anstyle/compare/{{tag_name}}...HEAD", exactly=1},
 ]
 
+[features]
+default = ["auto"]
+auto = ["dep:concolor-query", "dep:is-terminal"]
 
 [dependencies]
 anstyle = { version = "0.2.5", path = "../anstyle" }
+anstyle-parse = { version = "0.1.0", path = "../anstyle-parse" }
+concolor-query = { version = "0.2.0", optional = true }
+is-terminal = { version = "0.4.4", optional = true }
+utf8parse = "0.2.0"
+
+[dev-dependencies]
+criterion = "0.4.0"
+owo-colors = "3.5.0"
+proptest = "1.1.0"
+strip-ansi-escapes = "0.1.1"
+
+[[bench]]
+name = "strip"
+harness = false

crates/anstyle-stream/benches/strip.rs

@@ -0,0 +1,105 @@
+use criterion::{black_box, Criterion};
+
+#[derive(Default)]
+struct Strip(String);
+impl Strip {
+    fn with_capacity(capacity: usize) -> Self {
+        Self(String::with_capacity(capacity))
+    }
+}
+impl anstyle_parse::Perform for Strip {
+    fn print(&mut self, c: char) {
+        self.0.push(c);
+    }
+
+    fn execute(&mut self, byte: u8) {
+        if byte.is_ascii_whitespace() {
+            self.0.push(byte as char);
+        }
+    }
+}
+
+fn strip(c: &mut Criterion) {
+    for (name, content) in [
+        #[cfg(feature = "utf8")]
+        ("demo.vte", &include_bytes!("../tests/demo.vte")[..]),
+        ("rg_help.vte", &include_bytes!("../tests/rg_help.vte")[..]),
+        ("rg_linus.vte", &include_bytes!("../tests/rg_linus.vte")[..]),
+        (
+            "state_changes",
+            &b"\x1b]2;X\x1b\\ \x1b[0m \x1bP0@\x1b\\"[..],
+        ),
+    ] {
+        // Make sure the comparison is fair
+        if let Ok(content) = std::str::from_utf8(content) {
+            let mut stripped = Strip::with_capacity(content.len());
+            let mut parser = anstyle_parse::Parser::<anstyle_parse::DefaultCharAccumulator>::new();
+            for byte in content.as_bytes() {
+                parser.advance(&mut stripped, *byte);
+            }
+            assert_eq!(
+                stripped.0,
+                anstyle_stream::adapter::strip_str(content).to_string()
+            );
+            assert_eq!(
+                stripped.0,
+                String::from_utf8(
+                    anstyle_stream::adapter::strip_bytes(content.as_bytes()).into_vec()
+                )
+                .unwrap()
+            );
+        }
+
+        let mut group = c.benchmark_group(name);
+        group.bench_function("advance_strip", |b| {
+            b.iter(|| {
+                let mut stripped = Strip::with_capacity(content.len());
+                let mut parser =
+                    anstyle_parse::Parser::<anstyle_parse::DefaultCharAccumulator>::new();
+
+                for byte in content {
+                    parser.advance(&mut stripped, *byte);
+                }
+
+                black_box(stripped.0)
+            })
+        });
+        group.bench_function("strip_ansi_escapes", |b| {
+            b.iter(|| {
+                let stripped = strip_ansi_escapes::strip(content).unwrap();
+
+                black_box(stripped)
+            })
+        });
+        if let Ok(content) = std::str::from_utf8(content) {
+            group.bench_function("strip_str", |b| {
+                b.iter(|| {
+                    let stripped = anstyle_stream::adapter::strip_str(content).to_string();
+
+                    black_box(stripped)
+                })
+            });
+            group.bench_function("StripStr", |b| {
+                b.iter(|| {
+                    let mut stripped = String::with_capacity(content.len());
+                    let mut state = anstyle_stream::adapter::StripStr::new();
+                    for printable in state.strip_next(content) {
+                        stripped.push_str(printable);
+                    }
+
+                    black_box(stripped)
+                })
+            });
+        }
+        group.bench_function("strip_bytes", |b| {
+            b.iter(|| {
+                let stripped = anstyle_stream::adapter::strip_bytes(content).into_vec();
+
+                black_box(stripped)
+            })
+        });
+    }
+}
+
+criterion::criterion_group!(benches, strip);
+criterion::criterion_main!(benches);

crates/anstyle-stream/src/adapter/mod.rs

@@ -0,0 +1,12 @@
+//! Gracefully degrade styled output
+
+mod strip;
+
+pub use strip::strip_bytes;
+pub use strip::strip_str;
+pub use strip::StripBytes;
+pub use strip::StripBytesIter;
+pub use strip::StripStr;
+pub use strip::StripStrIter;
+pub use strip::StrippedBytes;
+pub use strip::StrippedStr;