pub enum Rule {
Show 152 variants
EOI,
WHITESPACE,
space,
line_comment,
block_comment,
program,
doc_comment,
definition,
trait_def,
impl_def,
impl_item,
self_identifier,
self_parameter,
struct_destructure,
tuple_destructure,
trailing_comma,
struct_def,
enum_def,
enum_variants,
enum_variant,
simple_variant,
tuple_variant,
struct_variant,
field_definitions,
field_def,
function_signature,
member_signature,
external_function,
normal_function,
member_def,
external_member_function,
normal_member_function,
function_def,
parameter_list,
parameter,
mut_keyword,
return_type,
for_loop,
mut_identifier,
for_pattern,
for_pair,
while_loop,
import_definition,
import_path,
import_list,
import_list_item,
return_expr,
continue_expr,
break_expr,
expression,
const_def,
assignment_expression,
multi_var_assignment,
multi_variable_list,
single_lhs_assignment,
assign_op,
compound_assign_op,
add_assign_op,
sub_assign_op,
mul_assign_op,
div_assign_op,
logical,
comparison,
addition,
multiplication,
prefix,
prefix_op,
array_suffix,
method_or_field_suffix,
function_call_args,
postfix,
postfix_op,
option_operator,
infix_op,
range_op,
op_or,
op_and,
op_eq,
op_neq,
op_lt,
op_gt,
op_lte,
op_gte,
op_add,
op_sub,
op_mul,
op_div,
op_not,
op_neg,
op_mod,
identifier,
type_identifier,
constant_identifier,
variable,
constant,
argument_list,
parenthesized,
function_argument,
function_call,
static_call,
array_index,
primary,
identifier_pattern,
if_expr,
expression_in_block,
block,
match_expr,
match_arms,
match_arm,
match_pattern,
enum_pattern,
variable_list,
variable_item,
pattern_list,
pattern_field,
wildcard_pattern,
built_in_type,
optional_type,
array_type,
map_type,
tuple_type,
struct_type_field,
type_name,
optional_marker,
base_type,
generic_params,
literal,
none_lit,
int_lit,
float_lit,
string_lit,
interpolated_string,
interpolated_content,
interpolation,
text,
format_specifier,
bool_lit,
unit_lit,
enum_literal,
tuple_lit,
struct_fields_lit,
array_literal,
map_literal,
map_entry,
struct_field,
qualified_identifier,
qualified_type_identifier,
module_segments,
struct_instantiation,
struct_field_list,
rest_fields,
tuple_fields,
}
Variants§
EOI
End-of-input
WHITESPACE
space
line_comment
block_comment
program
doc_comment
definition
trait_def
impl_def
impl_item
self_identifier
self_parameter
struct_destructure
tuple_destructure
trailing_comma
struct_def
enum_def
enum_variants
enum_variant
simple_variant
tuple_variant
struct_variant
field_definitions
field_def
function_signature
member_signature
external_function
normal_function
member_def
external_member_function
normal_member_function
function_def
parameter_list
parameter
mut_keyword
return_type
for_loop
mut_identifier
for_pattern
for_pair
while_loop
import_definition
import_path
import_list
import_list_item
return_expr
continue_expr
break_expr
expression
const_def
assignment_expression
multi_var_assignment
multi_variable_list
single_lhs_assignment
assign_op
compound_assign_op
add_assign_op
sub_assign_op
mul_assign_op
div_assign_op
logical
comparison
addition
multiplication
prefix
prefix_op
array_suffix
method_or_field_suffix
function_call_args
postfix
postfix_op
option_operator
infix_op
range_op
op_or
op_and
op_eq
op_neq
op_lt
op_gt
op_lte
op_gte
op_add
op_sub
op_mul
op_div
op_not
op_neg
op_mod
identifier
type_identifier
constant_identifier
variable
constant
argument_list
parenthesized
function_argument
function_call
static_call
array_index
primary
identifier_pattern
if_expr
expression_in_block
block
match_expr
match_arms
match_arm
match_pattern
enum_pattern
variable_list
variable_item
pattern_list
pattern_field
wildcard_pattern
built_in_type
optional_type
array_type
map_type
tuple_type
struct_type_field
type_name
optional_marker
base_type
generic_params
literal
none_lit
int_lit
float_lit
string_lit
interpolated_string
interpolated_content
interpolation
text
format_specifier
bool_lit
unit_lit
enum_literal
tuple_lit
struct_fields_lit
array_literal
map_literal
map_entry
struct_field
qualified_identifier
qualified_type_identifier
module_segments
struct_instantiation
struct_field_list
rest_fields
tuple_fields
Implementations§
Trait Implementations§
Source§impl Ord for Rule
impl Ord for Rule
Source§impl PartialOrd for Rule
impl PartialOrd for Rule
impl Copy for Rule
impl Eq for Rule
impl StructuralPartialEq for Rule
Auto Trait Implementations§
impl Freeze for Rule
impl RefUnwindSafe for Rule
impl Send for Rule
impl Sync for Rule
impl Unpin for Rule
impl UnwindSafe for Rule
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.bright_black());
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.bright_green());
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.bright_yellow());
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.bright_magenta());
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Returns self
with the
fg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.bright_white());
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlack
.
§Example
println!("{}", value.on_bright_black());
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightGreen
.
§Example
println!("{}", value.on_bright_green());
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightYellow
.
§Example
println!("{}", value.on_bright_yellow());
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightBlue
.
§Example
println!("{}", value.on_bright_blue());
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightMagenta
.
§Example
println!("{}", value.on_bright_magenta());
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightCyan
.
§Example
println!("{}", value.on_bright_cyan());
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Returns self
with the
bg()
set to
Color::BrightWhite
.
§Example
println!("{}", value.on_bright_white());
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn underline(&self) -> Painted<&T>
fn underline(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::Underline
.
§Example
println!("{}", value.underline());
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Returns self
with the
attr()
set to
Attribute::RapidBlink
.
§Example
println!("{}", value.rapid_blink());
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);