Add with_output_color. Fixes #426

bheisler · Jan 24, 2021 · 891d6d6 · 891d6d6
1 parent ffd0313
commit 891d6d6
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 ## [Unreleased]
 ### Added
 - Added support for benchmarking async functions
+- Added `with_output_color` for enabling or disabling CLI output coloring programmatically.
 
 ### Fixed
 - Criterion.rs will now give a clear error message in case of benchmarks that take zero time.

diff --git a/src/lib.rs b/src/lib.rs
@@ -661,6 +661,13 @@ impl<M: Measurement> Criterion<M> {
         self
     }
 
+    /// Override whether the CLI output will be colored or not. Usually you would use the `--color`
+    /// CLI argument, but this is available for programmmatic use as well.
+    pub fn with_output_color(mut self, enabled: bool) -> Criterion<M> {
+        self.report.cli.enable_text_coloring = enabled;
+        self
+    }
+
     /// Set the output directory (currently for testing only)
     #[doc(hidden)]
     pub fn output_directory(mut self, path: &Path) -> Criterion<M> {