helpers4 0.0.6

General-purpose Rust helpers, one crate, one feature per module (string, array, ...)
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

// This file is part of helpers4.
// Copyright (C) 2025 baxyz
// SPDX-License-Identifier: LGPL-3.0-or-later

/// Whether `text` contains an ANSI escape character (`ESC`, U+001B).
///
/// A cheap check for output that is styled, for instance to decide whether to strip it with
/// [`strip`](super::strip) before writing it to a file.
///
/// # Arguments
///
/// - `text` - The text to check.
///
/// # Returns
///
/// `true` when the text has an escape character.
///
/// # Examples
///
/// ```
/// use helpers4::ansi::contains;
///
/// assert!(contains("\u{1b}[32mok\u{1b}[0m"));
/// assert!(!contains("ok"));
/// ```
#[must_use]
pub fn contains(text: &str) -> bool {
    text.contains('\u{1b}')
}

#[cfg(test)]
#[path = "contains.test.rs"]
mod tests;