mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-09 09:38:24 +00:00
196 lines
68 KiB
HTML
196 lines
68 KiB
HTML
<!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="Extension trait for colorizing a type which implements any std formatter (`Display`, `Debug`, `UpperHex`, etc.)"><title>OwoColorize in owo_colors - 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="owo_colors" 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 trait"><!--[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="../owo_colors/index.html"><img src="https://jam1.re/img/rust_owo.svg" alt=""></a></nav><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../owo_colors/index.html"><img src="https://jam1.re/img/rust_owo.svg" alt="logo"></a><h2><a href="../owo_colors/index.html">owo_colors</a><span class="version">4.0.0</span></h2></div><h2 class="location"><a href="#">OwoColorize</a></h2><div class="sidebar-elems"><section><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.bg">bg</a></li><li><a href="#method.bg_rgb">bg_rgb</a></li><li><a href="#method.black">black</a></li><li><a href="#method.blink">blink</a></li><li><a href="#method.blink_fast">blink_fast</a></li><li><a href="#method.blue">blue</a></li><li><a href="#method.bold">bold</a></li><li><a href="#method.bright_black">bright_black</a></li><li><a href="#method.bright_blue">bright_blue</a></li><li><a href="#method.bright_cyan">bright_cyan</a></li><li><a href="#method.bright_green">bright_green</a></li><li><a href="#method.bright_magenta">bright_magenta</a></li><li><a href="#method.bright_purple">bright_purple</a></li><li><a href="#method.bright_red">bright_red</a></li><li><a href="#method.bright_white">bright_white</a></li><li><a href="#method.bright_yellow">bright_yellow</a></li><li><a href="#method.color">color</a></li><li><a href="#method.cyan">cyan</a></li><li><a href="#method.default_color">default_color</a></li><li><a href="#method.dimmed">dimmed</a></li><li><a href="#method.fg">fg</a></li><li><a href="#method.fg_rgb">fg_rgb</a></li><li><a href="#method.green">green</a></li><li><a href="#method.hidden">hidden</a></li><li><a href="#method.italic">italic</a></li><li><a href="#method.magenta">magenta</a></li><li><a href="#method.on_black">on_black</a></li><li><a href="#method.on_blue">on_blue</a></li><li><a href="#method.on_bright_black">on_bright_black</a></li><li><a href="#method.on_bright_blue">on_bright_blue</a></li><li><a href="#method.on_bright_cyan">on_bright_cyan</a></li><li><a href="#method.on_bright_green">on_bright_green</a></li><li><a href="#method.on_bright_magenta">on_bright_magenta</a></li><li><a href="#method.on_bright_purple">on_bright_purple</a></li><li><a href="#method.on_bright_red">on_bright_red</a></li><li><a href="#method.on_bright_white">on_bright_white</a></li><li><a href="#method.on_bright_yellow">on_bright_yellow</a></li><li><a href="#method.on_color">on_color</a></li><li><a href="#method.on_cyan">on_cyan</a></li><li><a href="#method.on_default_color">on_default_color</a></li><li><a href="#method.on_green">on_green</a></li><li><a href="#method.on_magenta">on_magenta</a></li><li><a href="#method.on_purple">on_purple</a></li><li><a href="#method.on_red">on_red</a></li><li><a href="#method.on_truecolor">on_truecolor</a></li><li><a href="#method.on_white">on_white</a></li><li><a href="#method.on_yellow">on_yellow</a></li><li><a href="#method.purple">purple</a></li><li><a href="#method.red">red</a></li><li><a href="#method.reversed">reversed</a></li><li><a href="#method.strikethrough">strikethrough</a></li><li><a href="#method.style">style</a></li><li><a href="#method.truecolor">truecolor</a></li><li><a href="#method.underline">underline</a></li><li><a href="#method.white">white</a></li><li><a href="#method.yellow">yellow</a></li></ul><h3><a href="#object-safety">Object Safety</a></h3><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In crate owo_colors</a></h2></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>Trait <a href="index.html">owo_colors</a>::<wbr><a class="trait" href="#">OwoColorize</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/owo_colors/lib.rs.html#260-477">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub trait OwoColorize: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
||
<details class="toggle type-contents-toggle"><summary class="hideme"><span>Show 56 methods</span></summary> // Provided methods
|
||
fn <a href="#method.fg" class="fn">fg</a><C: <a class="trait" href="trait.Color.html" title="trait owo_colors::Color">Color</a>>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, C, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bg" class="fn">bg</a><C: <a class="trait" href="trait.Color.html" title="trait owo_colors::Color">Color</a>>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, C, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.black" class="fn">black</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Black.html" title="struct owo_colors::colors::Black">Black</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_black" class="fn">on_black</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Black.html" title="struct owo_colors::colors::Black">Black</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.red" class="fn">red</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Red.html" title="struct owo_colors::colors::Red">Red</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_red" class="fn">on_red</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Red.html" title="struct owo_colors::colors::Red">Red</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.green" class="fn">green</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Green.html" title="struct owo_colors::colors::Green">Green</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_green" class="fn">on_green</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Green.html" title="struct owo_colors::colors::Green">Green</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.yellow" class="fn">yellow</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Yellow.html" title="struct owo_colors::colors::Yellow">Yellow</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_yellow" class="fn">on_yellow</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Yellow.html" title="struct owo_colors::colors::Yellow">Yellow</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.blue" class="fn">blue</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Blue.html" title="struct owo_colors::colors::Blue">Blue</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_blue" class="fn">on_blue</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Blue.html" title="struct owo_colors::colors::Blue">Blue</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.magenta" class="fn">magenta</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Magenta.html" title="struct owo_colors::colors::Magenta">Magenta</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_magenta" class="fn">on_magenta</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Magenta.html" title="struct owo_colors::colors::Magenta">Magenta</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.purple" class="fn">purple</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Magenta.html" title="struct owo_colors::colors::Magenta">Magenta</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_purple" class="fn">on_purple</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Magenta.html" title="struct owo_colors::colors::Magenta">Magenta</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.cyan" class="fn">cyan</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Cyan.html" title="struct owo_colors::colors::Cyan">Cyan</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_cyan" class="fn">on_cyan</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Cyan.html" title="struct owo_colors::colors::Cyan">Cyan</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.white" class="fn">white</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.White.html" title="struct owo_colors::colors::White">White</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_white" class="fn">on_white</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.White.html" title="struct owo_colors::colors::White">White</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.default_color" class="fn">default_color</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Default.html" title="struct owo_colors::colors::Default">Default</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_default_color" class="fn">on_default_color</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Default.html" title="struct owo_colors::colors::Default">Default</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bright_black" class="fn">bright_black</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightBlack.html" title="struct owo_colors::colors::BrightBlack">BrightBlack</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_bright_black" class="fn">on_bright_black</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightBlack.html" title="struct owo_colors::colors::BrightBlack">BrightBlack</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bright_red" class="fn">bright_red</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightRed.html" title="struct owo_colors::colors::BrightRed">BrightRed</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_bright_red" class="fn">on_bright_red</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightRed.html" title="struct owo_colors::colors::BrightRed">BrightRed</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bright_green" class="fn">bright_green</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightGreen.html" title="struct owo_colors::colors::BrightGreen">BrightGreen</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_bright_green" class="fn">on_bright_green</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightGreen.html" title="struct owo_colors::colors::BrightGreen">BrightGreen</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bright_yellow" class="fn">bright_yellow</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightYellow.html" title="struct owo_colors::colors::BrightYellow">BrightYellow</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_bright_yellow" class="fn">on_bright_yellow</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightYellow.html" title="struct owo_colors::colors::BrightYellow">BrightYellow</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bright_blue" class="fn">bright_blue</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightBlue.html" title="struct owo_colors::colors::BrightBlue">BrightBlue</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_bright_blue" class="fn">on_bright_blue</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightBlue.html" title="struct owo_colors::colors::BrightBlue">BrightBlue</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bright_magenta" class="fn">bright_magenta</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightMagenta.html" title="struct owo_colors::colors::BrightMagenta">BrightMagenta</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_bright_magenta" class="fn">on_bright_magenta</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightMagenta.html" title="struct owo_colors::colors::BrightMagenta">BrightMagenta</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bright_purple" class="fn">bright_purple</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightMagenta.html" title="struct owo_colors::colors::BrightMagenta">BrightMagenta</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_bright_purple" class="fn">on_bright_purple</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightMagenta.html" title="struct owo_colors::colors::BrightMagenta">BrightMagenta</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bright_cyan" class="fn">bright_cyan</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightCyan.html" title="struct owo_colors::colors::BrightCyan">BrightCyan</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_bright_cyan" class="fn">on_bright_cyan</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightCyan.html" title="struct owo_colors::colors::BrightCyan">BrightCyan</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bright_white" class="fn">bright_white</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightWhite.html" title="struct owo_colors::colors::BrightWhite">BrightWhite</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_bright_white" class="fn">on_bright_white</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightWhite.html" title="struct owo_colors::colors::BrightWhite">BrightWhite</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bold" class="fn">bold</a>(&self) -> <a class="struct" href="styles/struct.BoldDisplay.html" title="struct owo_colors::styles::BoldDisplay">BoldDisplay</a><'_, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.dimmed" class="fn">dimmed</a>(&self) -> <a class="struct" href="styles/struct.DimDisplay.html" title="struct owo_colors::styles::DimDisplay">DimDisplay</a><'_, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.italic" class="fn">italic</a>(&self) -> <a class="struct" href="styles/struct.ItalicDisplay.html" title="struct owo_colors::styles::ItalicDisplay">ItalicDisplay</a><'_, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.underline" class="fn">underline</a>(&self) -> <a class="struct" href="styles/struct.UnderlineDisplay.html" title="struct owo_colors::styles::UnderlineDisplay">UnderlineDisplay</a><'_, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.blink" class="fn">blink</a>(&self) -> <a class="struct" href="styles/struct.BlinkDisplay.html" title="struct owo_colors::styles::BlinkDisplay">BlinkDisplay</a><'_, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.blink_fast" class="fn">blink_fast</a>(&self) -> <a class="struct" href="styles/struct.BlinkFastDisplay.html" title="struct owo_colors::styles::BlinkFastDisplay">BlinkFastDisplay</a><'_, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.reversed" class="fn">reversed</a>(&self) -> <a class="struct" href="styles/struct.ReversedDisplay.html" title="struct owo_colors::styles::ReversedDisplay">ReversedDisplay</a><'_, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.hidden" class="fn">hidden</a>(&self) -> <a class="struct" href="styles/struct.HiddenDisplay.html" title="struct owo_colors::styles::HiddenDisplay">HiddenDisplay</a><'_, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.strikethrough" class="fn">strikethrough</a>(&self) -> <a class="struct" href="styles/struct.StrikeThroughDisplay.html" title="struct owo_colors::styles::StrikeThroughDisplay">StrikeThroughDisplay</a><'_, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.color" class="fn">color</a><Color: <a class="trait" href="trait.DynColor.html" title="trait owo_colors::DynColor">DynColor</a>>(
|
||
&self,
|
||
color: Color,
|
||
) -> <a class="struct" href="struct.FgDynColorDisplay.html" title="struct owo_colors::FgDynColorDisplay">FgDynColorDisplay</a><'_, Color, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_color" class="fn">on_color</a><Color: <a class="trait" href="trait.DynColor.html" title="trait owo_colors::DynColor">DynColor</a>>(
|
||
&self,
|
||
color: Color,
|
||
) -> <a class="struct" href="struct.BgDynColorDisplay.html" title="struct owo_colors::BgDynColorDisplay">BgDynColorDisplay</a><'_, Color, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.fg_rgb" class="fn">fg_rgb</a><const R: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, const G: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, const B: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>>(
|
||
&self,
|
||
) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.CustomColor.html" title="struct owo_colors::colors::CustomColor">CustomColor</a><R, G, B>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.bg_rgb" class="fn">bg_rgb</a><const R: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, const G: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, const B: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>>(
|
||
&self,
|
||
) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.CustomColor.html" title="struct owo_colors::colors::CustomColor">CustomColor</a><R, G, B>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.truecolor" class="fn">truecolor</a>(&self, r: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, g: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, b: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>) -> <a class="struct" href="struct.FgDynColorDisplay.html" title="struct owo_colors::FgDynColorDisplay">FgDynColorDisplay</a><'_, <a class="struct" href="struct.Rgb.html" title="struct owo_colors::Rgb">Rgb</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.on_truecolor" class="fn">on_truecolor</a>(
|
||
&self,
|
||
r: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>,
|
||
g: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>,
|
||
b: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>,
|
||
) -> <a class="struct" href="struct.BgDynColorDisplay.html" title="struct owo_colors::BgDynColorDisplay">BgDynColorDisplay</a><'_, <a class="struct" href="struct.Rgb.html" title="struct owo_colors::Rgb">Rgb</a>, Self> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.style" class="fn">style</a>(&self, style: <a class="struct" href="struct.Style.html" title="struct owo_colors::Style">Style</a>) -> <a class="struct" href="struct.Styled.html" title="struct owo_colors::Styled">Styled</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.reference.html">&Self</a>> { ... }
|
||
</details>}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Extension trait for colorizing a type which implements any std formatter
|
||
(<a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Display.html" title="trait core::fmt::Display"><code>Display</code></a>, <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug"><code>Debug</code></a>, <a href="https://doc.rust-lang.org/1.80.0/core/fmt/trait.UpperHex.html" title="trait core::fmt::UpperHex"><code>UpperHex</code></a>,
|
||
etc.)</p>
|
||
<h3 id="example"><a class="doc-anchor" href="#example">§</a>Example</h3>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>owo_colors::OwoColorize;
|
||
|
||
<span class="macro">println!</span>(<span class="string">"My number is {:#x}!"</span>, <span class="number">10</span>.green());
|
||
<span class="macro">println!</span>(<span class="string">"My number is not {}!"</span>, <span class="number">4</span>.on_red());</code></pre></div>
|
||
<h3 id="how-to-decide-which-method-to-use"><a class="doc-anchor" href="#how-to-decide-which-method-to-use">§</a>How to decide which method to use</h3>
|
||
<p><strong>Do you have a specific color you want to use?</strong></p>
|
||
<p>Use the specific color’s method, such as <a href="trait.OwoColorize.html#method.blue" title="method owo_colors::OwoColorize::blue"><code>blue</code></a> or
|
||
<a href="trait.OwoColorize.html#method.on_green" title="method owo_colors::OwoColorize::on_green"><code>on_green</code></a>.</p>
|
||
<p><strong>Do you want your colors configurable via generics?</strong></p>
|
||
<p>Use <a href="trait.OwoColorize.html#method.fg" title="method owo_colors::OwoColorize::fg"><code>fg</code></a> and <a href="trait.OwoColorize.html#method.bg" title="method owo_colors::OwoColorize::bg"><code>bg</code></a> to make it compile-time configurable.</p>
|
||
<p><strong>Do you need to pick a color at runtime?</strong></p>
|
||
<p>Use the <a href="trait.OwoColorize.html#method.color" title="method owo_colors::OwoColorize::color"><code>color</code></a>, <a href="trait.OwoColorize.html#method.on_color" title="method owo_colors::OwoColorize::on_color"><code>on_color</code></a>,
|
||
<a href="trait.OwoColorize.html#method.truecolor" title="method owo_colors::OwoColorize::truecolor"><code>truecolor</code></a> or <a href="trait.OwoColorize.html#method.on_truecolor" title="method owo_colors::OwoColorize::on_truecolor"><code>on_truecolor</code></a>.</p>
|
||
<p><strong>Do you need some other text modifier?</strong></p>
|
||
<ul>
|
||
<li><a href="trait.OwoColorize.html#method.bold" title="method owo_colors::OwoColorize::bold"><code>bold</code></a></li>
|
||
<li><a href="trait.OwoColorize.html#method.dimmed" title="method owo_colors::OwoColorize::dimmed"><code>dimmed</code></a></li>
|
||
<li><a href="trait.OwoColorize.html#method.italic" title="method owo_colors::OwoColorize::italic"><code>italic</code></a></li>
|
||
<li><a href="trait.OwoColorize.html#method.underline" title="method owo_colors::OwoColorize::underline"><code>underline</code></a></li>
|
||
<li><a href="trait.OwoColorize.html#method.blink" title="method owo_colors::OwoColorize::blink"><code>blink</code></a></li>
|
||
<li><a href="trait.OwoColorize.html#method.blink_fast" title="method owo_colors::OwoColorize::blink_fast"><code>blink_fast</code></a></li>
|
||
<li><a href="trait.OwoColorize.html#method.reversed" title="method owo_colors::OwoColorize::reversed"><code>reversed</code></a></li>
|
||
<li><a href="trait.OwoColorize.html#method.hidden" title="method owo_colors::OwoColorize::hidden"><code>hidden</code></a></li>
|
||
<li><a href="trait.OwoColorize.html#method.strikethrough" title="method owo_colors::OwoColorize::strikethrough"><code>strikethrough</code></a></li>
|
||
</ul>
|
||
<p><strong>Do you want it to only display colors if it’s a terminal?</strong></p>
|
||
<ol>
|
||
<li>Enable the <code>supports-colors</code> feature</li>
|
||
<li>Colorize inside <a href="OwoColorize::if_supports_color"><code>if_supports_color</code></a></li>
|
||
</ol>
|
||
<p><strong>Do you need to store a set of colors/effects to apply to multiple things?</strong></p>
|
||
<p>Use <a href="trait.OwoColorize.html#method.style" title="method owo_colors::OwoColorize::style"><code>style</code></a> to apply a <a href="struct.Style.html" title="struct owo_colors::Style"><code>Style</code></a></p>
|
||
</div></details><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.fg" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#270-272">source</a><h4 class="code-header">fn <a href="#method.fg" class="fn">fg</a><C: <a class="trait" href="trait.Color.html" title="trait owo_colors::Color">Color</a>>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, C, Self></h4></section></summary><div class="docblock"><p>Set the foreground color generically</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>owo_colors::{OwoColorize, colors::<span class="kw-2">*</span>};
|
||
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="string">"red foreground"</span>.fg::<Red>());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bg" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#283-285">source</a><h4 class="code-header">fn <a href="#method.bg" class="fn">bg</a><C: <a class="trait" href="trait.Color.html" title="trait owo_colors::Color">Color</a>>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, C, Self></h4></section></summary><div class="docblock"><p>Set the background color generically.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>owo_colors::{OwoColorize, colors::<span class="kw-2">*</span>};
|
||
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="string">"black background"</span>.bg::<Black>());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.black" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.black" class="fn">black</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Black.html" title="struct owo_colors::colors::Black">Black</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to black</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_black" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_black" class="fn">on_black</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Black.html" title="struct owo_colors::colors::Black">Black</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to black</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.red" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.red" class="fn">red</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Red.html" title="struct owo_colors::colors::Red">Red</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to red</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_red" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_red" class="fn">on_red</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Red.html" title="struct owo_colors::colors::Red">Red</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to red</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.green" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.green" class="fn">green</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Green.html" title="struct owo_colors::colors::Green">Green</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to green</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_green" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_green" class="fn">on_green</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Green.html" title="struct owo_colors::colors::Green">Green</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to green</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.yellow" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.yellow" class="fn">yellow</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Yellow.html" title="struct owo_colors::colors::Yellow">Yellow</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to yellow</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_yellow" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_yellow" class="fn">on_yellow</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Yellow.html" title="struct owo_colors::colors::Yellow">Yellow</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to yellow</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.blue" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.blue" class="fn">blue</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Blue.html" title="struct owo_colors::colors::Blue">Blue</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to blue</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_blue" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_blue" class="fn">on_blue</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Blue.html" title="struct owo_colors::colors::Blue">Blue</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to blue</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.magenta" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.magenta" class="fn">magenta</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Magenta.html" title="struct owo_colors::colors::Magenta">Magenta</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to magenta</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_magenta" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_magenta" class="fn">on_magenta</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Magenta.html" title="struct owo_colors::colors::Magenta">Magenta</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to magenta</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.purple" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.purple" class="fn">purple</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Magenta.html" title="struct owo_colors::colors::Magenta">Magenta</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to purple</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_purple" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_purple" class="fn">on_purple</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Magenta.html" title="struct owo_colors::colors::Magenta">Magenta</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to purple</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.cyan" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.cyan" class="fn">cyan</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Cyan.html" title="struct owo_colors::colors::Cyan">Cyan</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to cyan</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_cyan" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_cyan" class="fn">on_cyan</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Cyan.html" title="struct owo_colors::colors::Cyan">Cyan</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to cyan</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.white" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.white" class="fn">white</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.White.html" title="struct owo_colors::colors::White">White</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to white</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_white" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_white" class="fn">on_white</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.White.html" title="struct owo_colors::colors::White">White</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to white</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.default_color" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.default_color" class="fn">default_color</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.Default.html" title="struct owo_colors::colors::Default">Default</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to the terminal default</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_default_color" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_default_color" class="fn">on_default_color</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.Default.html" title="struct owo_colors::colors::Default">Default</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to the terminal default</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_black" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.bright_black" class="fn">bright_black</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightBlack.html" title="struct owo_colors::colors::BrightBlack">BrightBlack</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to bright black</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_black" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_bright_black" class="fn">on_bright_black</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightBlack.html" title="struct owo_colors::colors::BrightBlack">BrightBlack</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to bright black</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_red" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.bright_red" class="fn">bright_red</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightRed.html" title="struct owo_colors::colors::BrightRed">BrightRed</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to bright red</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_red" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_bright_red" class="fn">on_bright_red</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightRed.html" title="struct owo_colors::colors::BrightRed">BrightRed</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to bright red</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_green" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.bright_green" class="fn">bright_green</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightGreen.html" title="struct owo_colors::colors::BrightGreen">BrightGreen</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to bright green</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_green" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_bright_green" class="fn">on_bright_green</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightGreen.html" title="struct owo_colors::colors::BrightGreen">BrightGreen</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to bright green</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_yellow" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.bright_yellow" class="fn">bright_yellow</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightYellow.html" title="struct owo_colors::colors::BrightYellow">BrightYellow</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to bright yellow</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_yellow" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_bright_yellow" class="fn">on_bright_yellow</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightYellow.html" title="struct owo_colors::colors::BrightYellow">BrightYellow</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to bright yellow</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_blue" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.bright_blue" class="fn">bright_blue</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightBlue.html" title="struct owo_colors::colors::BrightBlue">BrightBlue</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to bright blue</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_blue" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_bright_blue" class="fn">on_bright_blue</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightBlue.html" title="struct owo_colors::colors::BrightBlue">BrightBlue</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to bright blue</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_magenta" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.bright_magenta" class="fn">bright_magenta</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightMagenta.html" title="struct owo_colors::colors::BrightMagenta">BrightMagenta</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to bright magenta</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_magenta" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_bright_magenta" class="fn">on_bright_magenta</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightMagenta.html" title="struct owo_colors::colors::BrightMagenta">BrightMagenta</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to bright magenta</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_purple" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.bright_purple" class="fn">bright_purple</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightMagenta.html" title="struct owo_colors::colors::BrightMagenta">BrightMagenta</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to bright purple</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_purple" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_bright_purple" class="fn">on_bright_purple</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightMagenta.html" title="struct owo_colors::colors::BrightMagenta">BrightMagenta</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to bright purple</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_cyan" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.bright_cyan" class="fn">bright_cyan</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightCyan.html" title="struct owo_colors::colors::BrightCyan">BrightCyan</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to bright cyan</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_cyan" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_bright_cyan" class="fn">on_bright_cyan</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightCyan.html" title="struct owo_colors::colors::BrightCyan">BrightCyan</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to bright cyan</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bright_white" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.bright_white" class="fn">bright_white</a>(&self) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightWhite.html" title="struct owo_colors::colors::BrightWhite">BrightWhite</a>, Self></h4></section></summary><div class="docblock"><p>Change the foreground color to bright white</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_bright_white" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#287-347">source</a><h4 class="code-header">fn <a href="#method.on_bright_white" class="fn">on_bright_white</a>(&self) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.BrightWhite.html" title="struct owo_colors::colors::BrightWhite">BrightWhite</a>, Self></h4></section></summary><div class="docblock"><p>Change the background color to bright white</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bold" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#349-368">source</a><h4 class="code-header">fn <a href="#method.bold" class="fn">bold</a>(&self) -> <a class="struct" href="styles/struct.BoldDisplay.html" title="struct owo_colors::styles::BoldDisplay">BoldDisplay</a><'_, Self></h4></section></summary><div class="docblock"><p>Make the text bold</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.dimmed" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#349-368">source</a><h4 class="code-header">fn <a href="#method.dimmed" class="fn">dimmed</a>(&self) -> <a class="struct" href="styles/struct.DimDisplay.html" title="struct owo_colors::styles::DimDisplay">DimDisplay</a><'_, Self></h4></section></summary><div class="docblock"><p>Make the text dim</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.italic" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#349-368">source</a><h4 class="code-header">fn <a href="#method.italic" class="fn">italic</a>(&self) -> <a class="struct" href="styles/struct.ItalicDisplay.html" title="struct owo_colors::styles::ItalicDisplay">ItalicDisplay</a><'_, Self></h4></section></summary><div class="docblock"><p>Make the text italicized</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.underline" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#349-368">source</a><h4 class="code-header">fn <a href="#method.underline" class="fn">underline</a>(&self) -> <a class="struct" href="styles/struct.UnderlineDisplay.html" title="struct owo_colors::styles::UnderlineDisplay">UnderlineDisplay</a><'_, Self></h4></section></summary><div class="docblock"><p>Make the text italicized</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.blink" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#349-368">source</a><h4 class="code-header">fn <a href="#method.blink" class="fn">blink</a>(&self) -> <a class="struct" href="styles/struct.BlinkDisplay.html" title="struct owo_colors::styles::BlinkDisplay">BlinkDisplay</a><'_, Self></h4></section></summary><div class="docblock"><p>Make the text blink</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.blink_fast" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#349-368">source</a><h4 class="code-header">fn <a href="#method.blink_fast" class="fn">blink_fast</a>(&self) -> <a class="struct" href="styles/struct.BlinkFastDisplay.html" title="struct owo_colors::styles::BlinkFastDisplay">BlinkFastDisplay</a><'_, Self></h4></section></summary><div class="docblock"><p>Make the text blink (but fast!)</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.reversed" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#349-368">source</a><h4 class="code-header">fn <a href="#method.reversed" class="fn">reversed</a>(&self) -> <a class="struct" href="styles/struct.ReversedDisplay.html" title="struct owo_colors::styles::ReversedDisplay">ReversedDisplay</a><'_, Self></h4></section></summary><div class="docblock"><p>Swap the foreground and background colors</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.hidden" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#349-368">source</a><h4 class="code-header">fn <a href="#method.hidden" class="fn">hidden</a>(&self) -> <a class="struct" href="styles/struct.HiddenDisplay.html" title="struct owo_colors::styles::HiddenDisplay">HiddenDisplay</a><'_, Self></h4></section></summary><div class="docblock"><p>Hide the text</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.strikethrough" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#349-368">source</a><h4 class="code-header">fn <a href="#method.strikethrough" class="fn">strikethrough</a>(&self) -> <a class="struct" href="styles/struct.StrikeThroughDisplay.html" title="struct owo_colors::styles::StrikeThroughDisplay">StrikeThroughDisplay</a><'_, Self></h4></section></summary><div class="docblock"><p>Cross out the text</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.color" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#381-383">source</a><h4 class="code-header">fn <a href="#method.color" class="fn">color</a><Color: <a class="trait" href="trait.DynColor.html" title="trait owo_colors::DynColor">DynColor</a>>(
|
||
&self,
|
||
color: Color,
|
||
) -> <a class="struct" href="struct.FgDynColorDisplay.html" title="struct owo_colors::FgDynColorDisplay">FgDynColorDisplay</a><'_, Color, Self></h4></section></summary><div class="docblock"><p>Set the foreground color at runtime. Only use if you do not know which color will be used at
|
||
compile-time. If the color is constant, use either <a href="trait.OwoColorize.html#method.fg" title="method owo_colors::OwoColorize::fg"><code>OwoColorize::fg</code></a> or
|
||
a color-specific method, such as <a href="trait.OwoColorize.html#method.green" title="method owo_colors::OwoColorize::green"><code>OwoColorize::green</code></a>,</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>owo_colors::{OwoColorize, AnsiColors};
|
||
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="string">"green"</span>.color(AnsiColors::Green));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_color" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#396-398">source</a><h4 class="code-header">fn <a href="#method.on_color" class="fn">on_color</a><Color: <a class="trait" href="trait.DynColor.html" title="trait owo_colors::DynColor">DynColor</a>>(
|
||
&self,
|
||
color: Color,
|
||
) -> <a class="struct" href="struct.BgDynColorDisplay.html" title="struct owo_colors::BgDynColorDisplay">BgDynColorDisplay</a><'_, Color, Self></h4></section></summary><div class="docblock"><p>Set the background color at runtime. Only use if you do not know what color to use at
|
||
compile-time. If the color is constant, use either <a href="trait.OwoColorize.html#method.bg" title="method owo_colors::OwoColorize::bg"><code>OwoColorize::bg</code></a> or
|
||
a color-specific method, such as <a href="trait.OwoColorize.html#method.on_yellow" title="method owo_colors::OwoColorize::on_yellow"><code>OwoColorize::on_yellow</code></a>,</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>owo_colors::{OwoColorize, AnsiColors};
|
||
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, <span class="string">"yellow background"</span>.on_color(AnsiColors::BrightYellow));</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.fg_rgb" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#402-406">source</a><h4 class="code-header">fn <a href="#method.fg_rgb" class="fn">fg_rgb</a><const R: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, const G: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, const B: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>>(
|
||
&self,
|
||
) -> <a class="struct" href="struct.FgColorDisplay.html" title="struct owo_colors::FgColorDisplay">FgColorDisplay</a><'_, <a class="struct" href="colors/struct.CustomColor.html" title="struct owo_colors::colors::CustomColor">CustomColor</a><R, G, B>, Self></h4></section></summary><div class="docblock"><p>Set the foreground color to a specific RGB value.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.bg_rgb" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#410-414">source</a><h4 class="code-header">fn <a href="#method.bg_rgb" class="fn">bg_rgb</a><const R: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, const G: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, const B: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>>(
|
||
&self,
|
||
) -> <a class="struct" href="struct.BgColorDisplay.html" title="struct owo_colors::BgColorDisplay">BgColorDisplay</a><'_, <a class="struct" href="colors/struct.CustomColor.html" title="struct owo_colors::colors::CustomColor">CustomColor</a><R, G, B>, Self></h4></section></summary><div class="docblock"><p>Set the background color to a specific RGB value.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.truecolor" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#419-421">source</a><h4 class="code-header">fn <a href="#method.truecolor" class="fn">truecolor</a>(&self, r: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, g: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, b: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>) -> <a class="struct" href="struct.FgDynColorDisplay.html" title="struct owo_colors::FgDynColorDisplay">FgDynColorDisplay</a><'_, <a class="struct" href="struct.Rgb.html" title="struct owo_colors::Rgb">Rgb</a>, Self></h4></section></summary><div class="docblock"><p>Sets the foreground color to an RGB value.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.on_truecolor" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#426-428">source</a><h4 class="code-header">fn <a href="#method.on_truecolor" class="fn">on_truecolor</a>(&self, r: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, g: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>, b: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.u8.html">u8</a>) -> <a class="struct" href="struct.BgDynColorDisplay.html" title="struct owo_colors::BgDynColorDisplay">BgDynColorDisplay</a><'_, <a class="struct" href="struct.Rgb.html" title="struct owo_colors::Rgb">Rgb</a>, Self></h4></section></summary><div class="docblock"><p>Sets the background color to an RGB value.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.style" class="method"><a class="src rightside" href="../src/owo_colors/lib.rs.html#432-434">source</a><h4 class="code-header">fn <a href="#method.style" class="fn">style</a>(&self, style: <a class="struct" href="struct.Style.html" title="struct owo_colors::Style">Style</a>) -> <a class="struct" href="struct.Styled.html" title="struct owo_colors::Styled">Styled</a><<a class="primitive" href="https://doc.rust-lang.org/1.80.0/core/primitive.reference.html">&Self</a>></h4></section></summary><div class="docblock"><p>Apply a runtime-determined style</p>
|
||
</div></details></div><h2 id="object-safety" class="section-header">Object Safety<a href="#object-safety" class="anchor">§</a></h2><div class="object-safety-info">This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.80.0/reference/items/traits.html#object-safety">object safe</a>.</div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-OwoColorize-for-D" class="impl"><a class="src rightside" href="../src/owo_colors/lib.rs.html#497">source</a><a href="#impl-OwoColorize-for-D" class="anchor">§</a><h3 class="code-header">impl<D: <a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.OwoColorize.html" title="trait owo_colors::OwoColorize">OwoColorize</a> for D</h3></section></div><script src="../trait.impl/owo_colors/trait.OwoColorize.js" async></script></section></div></main></body></html> |