Struct grep_printer::UserColorSpec
source · pub struct UserColorSpec { /* private fields */ }
Expand description
A single color specification provided by the user.
Format
The format of a Spec
is a triple: {type}:{attribute}:{value}
. Each
component is defined as follows:
{type}
can be one ofpath
,line
,column
ormatch
.{attribute}
can be one offg
,bg
orstyle
.{attribute}
may also be the special valuenone
, in which case,{value}
can be omitted.{value}
is either a color name (forfg
/bg
) or a style instruction.
{type}
controls which part of the output should be styled.
When {attribute}
is none
, then this should cause any existing style
settings to be cleared for the specified type
.
{value}
should be a color when {attribute}
is fg
or bg
, or it
should be a style instruction when {attribute}
is style
. When
{attribute}
is none
, {value}
must be omitted.
Valid colors are black
, blue
, green
, red
, cyan
, magenta
,
yellow
, white
. Extended colors can also be specified, and are formatted
as x
(for 256-bit colors) or x,x,x
(for 24-bit true color), where
x
is a number between 0 and 255 inclusive. x
may be given as a normal
decimal number of a hexadecimal number, where the latter is prefixed by
0x
.
Valid style instructions are nobold
, bold
, intense
, nointense
,
underline
, nounderline
.
Example
The standard way to build a UserColorSpec
is to parse it from a string.
Once multiple UserColorSpec
s have been constructed, they can be provided
to the standard printer where they will automatically be applied to the
output.
A UserColorSpec
can also be converted to a termcolor::ColorSpec
:
use termcolor::{Color, ColorSpec};
use grep_printer::UserColorSpec;
let user_spec1: UserColorSpec = "path:fg:blue".parse().unwrap();
let user_spec2: UserColorSpec = "match:bg:0xff,0x7f,0x00".parse().unwrap();
let spec1 = user_spec1.to_color_spec();
let spec2 = user_spec2.to_color_spec();
assert_eq!(spec1.fg(), Some(&Color::Blue));
assert_eq!(spec2.bg(), Some(&Color::Rgb(0xFF, 0x7F, 0x00)));
Implementations§
source§impl UserColorSpec
impl UserColorSpec
sourcepub fn to_color_spec(&self) -> ColorSpec
pub fn to_color_spec(&self) -> ColorSpec
Convert this user provided color specification to a specification that
can be used with termcolor
. This drops the type of this specification
(where the type indicates where the color is applied in the standard
printer, e.g., to the file path or the line numbers, etc.).
Trait Implementations§
source§impl Clone for UserColorSpec
impl Clone for UserColorSpec
source§fn clone(&self) -> UserColorSpec
fn clone(&self) -> UserColorSpec
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for UserColorSpec
impl Debug for UserColorSpec
source§impl FromStr for UserColorSpec
impl FromStr for UserColorSpec
§type Err = ColorError
type Err = ColorError
source§fn from_str(s: &str) -> Result<UserColorSpec, ColorError>
fn from_str(s: &str) -> Result<UserColorSpec, ColorError>
s
to return a value of this type. Read moresource§impl PartialEq<UserColorSpec> for UserColorSpec
impl PartialEq<UserColorSpec> for UserColorSpec
source§fn eq(&self, other: &UserColorSpec) -> bool
fn eq(&self, other: &UserColorSpec) -> bool
self
and other
values to be equal, and is used
by ==
.