2024-07-26 09:42:18 +00:00
<!DOCTYPE html> < html lang = "en" > < head > < meta charset = "utf-8" > < meta name = "viewport" content = "width=device-width, initial-scale=1.0" > < meta name = "generator" content = "rustdoc" > < meta name = "description" content = "Check CLICOLOR status" > < title > clicolor in concolor_query - Rust< / title > < script > if ( window . location . protocol !== "file:" ) document . head . insertAdjacentHTML ( "beforeend" , "SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2" . split ( "," ) . map ( f => ` <link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/ ${ f } "> ` ) . join ( "" ) ) < / script > < link rel = "stylesheet" href = "../static.files/normalize-76eba96aa4d2e634.css" > < link rel = "stylesheet" href = "../static.files/rustdoc-dd39b87e5fcfba68.css" > < meta name = "rustdoc-vars" data-root-path = "../" data-static-root-path = "../static.files/" data-current-crate = "concolor_query" data-themes = "" data-resource-suffix = "" data-rustdoc-version = "1.80.0 (051478957 2024-07-21)" data-channel = "1.80.0" data-search-js = "search-d52510db62a78183.js" data-settings-js = "settings-4313503d2e1961c2.js" > < script src = "../static.files/storage-118b08c4c78b968e.js" > < / script > < script defer src = "sidebar-items.js" > < / script > < script defer src = "../static.files/main-20a3ad099b048cf2.js" > < / script > < noscript > < link rel = "stylesheet" href = "../static.files/noscript-df360f571f6edeae.css" > < / noscript > < link rel = "alternate icon" type = "image/png" href = "../static.files/favicon-32x32-422f7d1d52889060.png" > < link rel = "icon" type = "image/svg+xml" href = "../static.files/favicon-2c020d218678b618.svg" > < / head > < body class = "rustdoc fn" > <!-- [if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif] --> < nav class = "mobile-topbar" > < button class = "sidebar-menu-toggle" title = "show sidebar" > < / button > < / nav > < nav class = "sidebar" > < div class = "sidebar-crate" > < h2 > < a href = "../concolor_query/index.html" > concolor_query< / a > < span class = "version" > 0.3.3< / span > < / h2 > < / div > < div class = "sidebar-elems" > < / div > < / nav > < div class = "sidebar-resizer" > < / div > < main > < div class = "width-limiter" > < rustdoc-search > < / rustdoc-search > < section id = "main-content" class = "content" > < div class = "main-heading" > < h1 > Function < a href = "index.html" > concolor_query< / a > ::< wbr > < a class = "fn" href = "#" > clicolor< / a > < button id = "copy-path" title = "Copy item path to clipboard" > Copy item path< / button > < / h1 > < span class = "out-of-band" > < a class = "src" href = "../src/concolor_query/lib.rs.html#16-19" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub fn clicolor() -> < a class = "enum" href = "https://doc.rust-lang.org/1.80.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.bool.html" > bool< / a > > < / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Check < a href = "https://bixense.com/clicolors/" > CLICOLOR< / a > status< / p >
2024-02-13 06:38:44 +00:00
< ul >
< li > When < code > true< / code > , ANSI colors are supported and should be used when the program isn’ t piped,
similar to < a href = "fn.term_supports_color.html" title = "fn concolor_query::term_supports_color" > < code > term_supports_color< / code > < / a > < / li >
< li > When < code > false< / code > , don’ t output ANSI color escape codes, similar to < a href = "fn.no_color.html" title = "fn concolor_query::no_color" > < code > no_color< / code > < / a > < / li >
< / ul >
< p > See also:< / p >
< ul >
< li > < a href = "https://crates.io/crates/terminfo" > terminfo< / a > or < a href = "https://crates.io/crates/term" > term< / a > for
checking termcaps< / li >
< li > < a href = "https://crates.io/crates/termbg" > termbg< / a > for detecting background color< / li >
< / ul >
< / div > < / details > < / section > < / div > < / main > < / body > < / html >