pub struct Formatter<'a, W> { /* private fields */ }Expand description
A Solidity formatter
Implementations§
Source§impl<'a, W: Write> Formatter<'a, W>
impl<'a, W: Write> Formatter<'a, W>
pub fn new( w: W, source: &'a str, comments: Comments, inline_config: InlineConfig, config: FormatterConfig, ) -> Self
Trait Implementations§
Source§impl<W: Write> Visitor for Formatter<'_, W>
impl<W: Write> Visitor for Formatter<'_, W>
type Error = FormatterError
fn visit_source(&mut self, loc: Loc) -> Result<(), FormatterError>
fn visit_source_unit( &mut self, source_unit: &mut SourceUnit, ) -> Result<(), FormatterError>
fn visit_contract( &mut self, contract: &mut ContractDefinition, ) -> Result<(), FormatterError>
fn visit_annotation( &mut self, annotation: &mut Annotation, ) -> Result<(), FormatterError>
fn visit_pragma( &mut self, pragma: &PragmaDirective, ) -> Result<(), FormatterError>
fn visit_version( &mut self, loc: Loc, version: &VersionComparator, ) -> Result<(), FormatterError>
fn visit_import_plain( &mut self, loc: Loc, import: &mut ImportPath, ) -> Result<(), FormatterError>
fn visit_import_global( &mut self, loc: Loc, global: &mut ImportPath, alias: &mut Identifier, ) -> Result<(), FormatterError>
fn visit_import_renames( &mut self, loc: Loc, imports: &mut [(Identifier, Option<Identifier>)], from: &mut ImportPath, ) -> Result<(), FormatterError>
fn visit_enum( &mut self, enumeration: &mut EnumDefinition, ) -> Result<(), FormatterError>
fn visit_assembly( &mut self, loc: Loc, dialect: &mut Option<StringLiteral>, block: &mut YulBlock, flags: &mut Option<Vec<StringLiteral>>, ) -> Result<(), Self::Error>
fn visit_block( &mut self, loc: Loc, unchecked: bool, statements: &mut Vec<Statement>, ) -> Result<(), FormatterError>
fn visit_args( &mut self, loc: Loc, args: &mut Vec<NamedArgument>, ) -> Result<(), Self::Error>
Source§fn visit_expr(
&mut self,
loc: Loc,
expr: &mut Expression,
) -> Result<(), FormatterError>
fn visit_expr( &mut self, loc: Loc, expr: &mut Expression, ) -> Result<(), FormatterError>
Don’t write semicolon at the end because expressions can appear as both
part of other node and a statement in the function body
fn visit_ident( &mut self, loc: Loc, ident: &mut Identifier, ) -> Result<(), FormatterError>
fn visit_ident_path( &mut self, idents: &mut IdentifierPath, ) -> Result<(), Self::Error>
fn visit_emit( &mut self, loc: Loc, event: &mut Expression, ) -> Result<(), FormatterError>
fn visit_var_definition( &mut self, var: &mut VariableDefinition, ) -> Result<(), FormatterError>
fn visit_var_definition_stmt( &mut self, loc: Loc, declaration: &mut VariableDeclaration, expr: &mut Option<Expression>, ) -> Result<(), FormatterError>
fn visit_var_declaration( &mut self, var: &mut VariableDeclaration, ) -> Result<(), FormatterError>
fn visit_return( &mut self, loc: Loc, expr: &mut Option<Expression>, ) -> Result<(), Self::Error>
fn visit_revert( &mut self, loc: Loc, error: &mut Option<IdentifierPath>, args: &mut Vec<Expression>, ) -> Result<(), Self::Error>
fn visit_revert_named_args( &mut self, loc: Loc, error: &mut Option<IdentifierPath>, args: &mut Vec<NamedArgument>, ) -> Result<(), Self::Error>
fn visit_break( &mut self, loc: Loc, semicolon: bool, ) -> Result<(), FormatterError>
fn visit_continue( &mut self, loc: Loc, semicolon: bool, ) -> Result<(), FormatterError>
fn visit_try( &mut self, loc: Loc, expr: &mut Expression, returns: &mut Option<(Vec<(Loc, Option<Parameter>)>, Box<Statement>)>, clauses: &mut Vec<CatchClause>, ) -> Result<(), Self::Error>
fn visit_if( &mut self, loc: Loc, cond: &mut Expression, if_branch: &mut Box<Statement>, else_branch: &mut Option<Box<Statement>>, is_first_stmt: bool, ) -> Result<(), Self::Error>
fn visit_do_while( &mut self, loc: Loc, body: &mut Statement, cond: &mut Expression, ) -> Result<(), Self::Error>
fn visit_while( &mut self, loc: Loc, cond: &mut Expression, body: &mut Statement, ) -> Result<(), Self::Error>
fn visit_for( &mut self, loc: Loc, init: &mut Option<Box<Statement>>, cond: &mut Option<Box<Expression>>, update: &mut Option<Box<Expression>>, body: &mut Option<Box<Statement>>, ) -> Result<(), Self::Error>
fn visit_function( &mut self, func: &mut FunctionDefinition, ) -> Result<(), FormatterError>
fn visit_function_attribute( &mut self, attribute: &mut FunctionAttribute, ) -> Result<(), FormatterError>
fn visit_var_attribute( &mut self, attribute: &mut VariableAttribute, ) -> Result<(), FormatterError>
fn visit_base(&mut self, base: &mut Base) -> Result<(), FormatterError>
fn visit_parameter( &mut self, parameter: &mut Parameter, ) -> Result<(), FormatterError>
fn visit_struct( &mut self, structure: &mut StructDefinition, ) -> Result<(), FormatterError>
fn visit_event( &mut self, event: &mut EventDefinition, ) -> Result<(), FormatterError>
fn visit_event_parameter( &mut self, param: &mut EventParameter, ) -> Result<(), FormatterError>
fn visit_error( &mut self, error: &mut ErrorDefinition, ) -> Result<(), FormatterError>
fn visit_error_parameter( &mut self, param: &mut ErrorParameter, ) -> Result<(), FormatterError>
fn visit_type_definition( &mut self, def: &mut TypeDefinition, ) -> Result<(), FormatterError>
fn visit_stray_semicolon(&mut self) -> Result<(), FormatterError>
fn visit_opening_paren(&mut self) -> Result<(), FormatterError>
fn visit_closing_paren(&mut self) -> Result<(), FormatterError>
fn visit_newline(&mut self) -> Result<(), FormatterError>
fn visit_using(&mut self, using: &mut Using) -> Result<(), FormatterError>
fn visit_yul_block( &mut self, loc: Loc, statements: &mut Vec<YulStatement>, attempt_single_line: bool, ) -> Result<(), Self::Error>
fn visit_yul_expr( &mut self, expr: &mut YulExpression, ) -> Result<(), Self::Error>
fn visit_yul_assignment<T>(
&mut self,
loc: Loc,
exprs: &mut Vec<T>,
expr: &mut Option<&mut YulExpression>,
) -> Result<(), Self::Error>where
T: Visitable + CodeLocation,
fn visit_yul_for(&mut self, stmt: &mut YulFor) -> Result<(), Self::Error>
fn visit_yul_function_call( &mut self, stmt: &mut YulFunctionCall, ) -> Result<(), Self::Error>
fn visit_yul_fun_def( &mut self, stmt: &mut YulFunctionDefinition, ) -> Result<(), Self::Error>
fn visit_yul_if( &mut self, loc: Loc, expr: &mut YulExpression, block: &mut YulBlock, ) -> Result<(), Self::Error>
fn visit_yul_leave(&mut self, loc: Loc) -> Result<(), Self::Error>
fn visit_yul_switch(&mut self, stmt: &mut YulSwitch) -> Result<(), Self::Error>
fn visit_yul_var_declaration( &mut self, loc: Loc, idents: &mut Vec<YulTypedIdentifier>, expr: &mut Option<YulExpression>, ) -> Result<(), Self::Error>
fn visit_yul_typed_ident( &mut self, ident: &mut YulTypedIdentifier, ) -> Result<(), Self::Error>
fn visit_parser_error(&mut self, loc: Loc) -> Result<(), FormatterError>
Auto Trait Implementations§
impl<'a, W> Freeze for Formatter<'a, W>where
W: Freeze,
impl<'a, W> RefUnwindSafe for Formatter<'a, W>where
W: RefUnwindSafe,
impl<'a, W> Send for Formatter<'a, W>where
W: Send,
impl<'a, W> Sync for Formatter<'a, W>where
W: Sync,
impl<'a, W> Unpin for Formatter<'a, W>where
W: Unpin,
impl<'a, W> UnwindSafe for Formatter<'a, W>where
W: UnwindSafe,
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
Mutably borrows from an owned value. Read more
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> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§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>
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>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
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>
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>
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>
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>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
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 rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
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);