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 = "Unconditionally enables styling globally." > < title > enable in yansi - 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 = "yansi" 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 > < a class = "logo-container" href = "../yansi/index.html" > < img src = "https://raw.githubusercontent.com/SergioBenitez/yansi/master/.github/yansi-logo.png" alt = "" > < / a > < / nav > < nav class = "sidebar" > < div class = "sidebar-crate" > < a class = "logo-container" href = "../yansi/index.html" > < img src = "https://raw.githubusercontent.com/SergioBenitez/yansi/master/.github/yansi-logo.png" alt = "logo" > < / a > < h2 > < a href = "../yansi/index.html" > yansi< / a > < span class = "version" > 1.0.1< / 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" > yansi< / a > ::< wbr > < a class = "fn" href = "#" > enable< / 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/yansi/global.rs.html#41-43" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub fn enable()< / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Unconditionally enables styling globally.< / p >
2024-05-05 09:43:20 +00:00
< p > By default, styling is enabled based on < a href = "struct.Condition.html#associatedconstant.DEFAULT" title = "associated constant yansi::Condition::DEFAULT" > < code > Condition::DEFAULT< / code > < / a > , which checks
for operating system support.< / p >
< h2 id = "example" > < a class = "doc-anchor" href = "#example" > §< / a > Example< / h2 >
< div class = "example-wrap" > < pre class = "rust rust-example-rendered" > < code > < span class = "kw" > use < / span > yansi::Paint;
< span class = "comment" > // With styling disabled, ANSI color codes are _not_ emitted.
< / span > yansi::disable();
< span class = "macro" > assert_eq!< / span > (< span class = "string" > "go"< / span > .green().to_string(), < span class = "string" > "go"< / span > .to_string());
< span class = "comment" > // Reenabling causes color code to be emitted.
< / span > yansi::enable();
< span class = "macro" > assert_ne!< / span > (< span class = "string" > "go"< / span > .green().to_string(), < span class = "string" > "go"< / span > .to_string());< / code > < / pre > < / div >
< / div > < / details > < / section > < / div > < / main > < / body > < / html >
