pub struct Walker<V, C = Infallible, CW = AnyWalker<C>>{ /* private fields */ }
Expand description
Wrapper for visitor that calls inner visitors.
Inner visitor should implement Visitor
trait and
syn::visit_mut::VisitMut
.
For regular usecases it is recommended to use visit_nodes
,
visit_nodes_with_custom
or visit_attributes
functions.
But if you need it can be used by calling visit_*
methods directly.
Example:
use quote::quote;
use rstml::{
node::{Node, NodeText},
visitor::{Visitor, Walker},
Infallible,
};
use syn::parse_quote;
struct TestVisitor;
impl<C> Visitor<C> for TestVisitor {
fn visit_text_node(&mut self, node: &mut NodeText) -> bool {
*node = parse_quote!("modified");
true
}
}
impl syn::visit_mut::VisitMut for TestVisitor {}
let mut visitor = Walker::new(TestVisitor);
let tokens = quote! {
<div>
<span>"Some raw text"</span>
<span></span>"And text after span"
</div>
};
let mut nodes = rstml::parse2(tokens).unwrap();
for node in &mut nodes {
visitor.visit_node(node);
}
let result = quote! {
#(#nodes)*
};
assert_eq!(
result.to_string(),
quote! {
<div>
<span>"modified"</span>
<span></span>"modified"
</div>
}
.to_string()
);
Implementations§
source§impl<V, C> Walker<V, C>
impl<V, C> Walker<V, C>
pub fn new(visitor: V) -> Self
pub fn with_custom_handler<OtherCW>(visitor: V) -> Walker<V, C, OtherCW>where
OtherCW: CustomNodeWalker<Custom = C>,
Trait Implementations§
source§impl<V, C, CW> Visitor<C> for Walker<V, C, CW>
impl<V, C, CW> Visitor<C> for Walker<V, C, CW>
fn visit_node(&mut self, node: &mut Node<C>) -> bool
fn visit_block(&mut self, node: &mut NodeBlock) -> bool
fn visit_comment(&mut self, node: &mut NodeComment) -> bool
fn visit_doctype(&mut self, node: &mut NodeDoctype) -> bool
fn visit_raw_node<OtherC: CustomNode>( &mut self, node: &mut RawText<OtherC>, ) -> bool
fn visit_custom(&mut self, node: &mut C) -> bool
fn visit_text_node(&mut self, node: &mut NodeText) -> bool
fn visit_element(&mut self, node: &mut NodeElement<C>) -> bool
fn visit_fragment(&mut self, node: &mut NodeFragment<C>) -> bool
fn visit_open_tag(&mut self, open_tag: &mut OpenTag) -> bool
fn visit_close_tag(&mut self, closed_tag: &mut CloseTag) -> bool
fn visit_attribute(&mut self, attribute: &mut NodeAttribute) -> bool
fn visit_keyed_attribute(&mut self, attribute: &mut KeyedAttribute) -> bool
fn visit_attribute_flag(&mut self, key: &mut NodeName) -> bool
fn visit_attribute_binding( &mut self, key: &mut NodeName, value: &mut FnBinding, ) -> bool
fn visit_attribute_value( &mut self, key: &mut NodeName, value: &mut AttributeValueExpr, ) -> bool
fn visit_invalid_block(&mut self, block: &mut InvalidBlock) -> bool
fn visit_node_name(&mut self, name: &mut NodeName) -> bool
fn visit_rust_code(&mut self, code: RustCode<'_>) -> bool
Auto Trait Implementations§
impl<V, C, CW> Freeze for Walker<V, C, CW>where
V: Freeze,
impl<V, C, CW> RefUnwindSafe for Walker<V, C, CW>
impl<V, C, CW> Send for Walker<V, C, CW>
impl<V, C, CW> Sync for Walker<V, C, CW>
impl<V, C, CW> Unpin for Walker<V, C, CW>
impl<V, C, CW> UnwindSafe for Walker<V, C, CW>
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> 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);