Struct rustc_ast_pretty::pprust::state::State

source ·
pub struct State<'a> {
    pub s: Printer,
    comments: Option<Comments<'a>>,
    ann: &'a (dyn PpAnn + 'a),
}

Fields§

§s: Printer§comments: Option<Comments<'a>>§ann: &'a (dyn PpAnn + 'a)

Implementations§

source§

impl<'a> State<'a>

source

fn print_else(&mut self, els: Option<&Expr>)

source

fn print_if(&mut self, test: &Expr, blk: &Block, elseopt: Option<&Expr>)

source

fn print_call_post(&mut self, args: &[P<Expr>])

source

fn print_expr_maybe_paren(&mut self, expr: &Expr, prec: i8, fixup: FixupContext)

source

fn print_expr_as_cond(&mut self, expr: &Expr)

Prints an expr using syntax that’s acceptable in a condition position, such as the cond in if cond { ... }.

source

fn cond_needs_par(expr: &Expr) -> bool

Does expr need parentheses when printed in a condition position?

These cases need parens due to the parse error observed in #26461: if return {} parses as the erroneous construct if (return {}), not if (return) {}.

source

pub(super) fn print_expr_cond_paren( &mut self, expr: &Expr, needs_par: bool, fixup: FixupContext )

Prints expr or (expr) when needs_par holds.

source

fn print_expr_vec(&mut self, exprs: &[P<Expr>])

source

pub(super) fn print_expr_anon_const( &mut self, expr: &AnonConst, attrs: &[Attribute] )

source

fn print_expr_repeat(&mut self, element: &Expr, count: &AnonConst)

source

fn print_expr_struct( &mut self, qself: &Option<P<QSelf>>, path: &Path, fields: &[ExprField], rest: &StructRest )

source

fn print_expr_tup(&mut self, exprs: &[P<Expr>])

source

fn print_expr_call( &mut self, func: &Expr, args: &[P<Expr>], fixup: FixupContext )

source

fn print_expr_method_call( &mut self, segment: &PathSegment, receiver: &Expr, base_args: &[P<Expr>], fixup: FixupContext )

source

fn print_expr_binary( &mut self, op: BinOp, lhs: &Expr, rhs: &Expr, fixup: FixupContext )

source

fn print_expr_unary(&mut self, op: UnOp, expr: &Expr, fixup: FixupContext)

source

fn print_expr_addr_of( &mut self, kind: BorrowKind, mutability: Mutability, expr: &Expr, fixup: FixupContext )

source

pub(super) fn print_expr(&mut self, expr: &Expr, fixup: FixupContext)

source

pub(super) fn print_expr_outer_attr_style( &mut self, expr: &Expr, is_inline: bool, fixup: FixupContext )

source

fn print_arm(&mut self, arm: &Arm)

source

fn print_closure_binder(&mut self, binder: &ClosureBinder)

source

fn print_movability(&mut self, movability: Movability)

source

fn print_capture_clause(&mut self, capture_clause: CaptureBy)

source§

impl<'a> State<'a>

source

fn print_foreign_mod(&mut self, nmod: &ForeignMod, attrs: &[Attribute])

source

fn print_foreign_item(&mut self, item: &ForeignItem)

source

fn print_item_const( &mut self, ident: Ident, mutbl: Option<Mutability>, generics: &Generics, ty: &Ty, body: Option<&Expr>, vis: &Visibility, defaultness: Defaultness )

source

fn print_associated_type( &mut self, ident: Ident, generics: &Generics, where_clauses: TyAliasWhereClauses, bounds: &GenericBounds, ty: Option<&Ty>, vis: &Visibility, defaultness: Defaultness )

source

pub(crate) fn print_item(&mut self, item: &Item)

Pretty-prints an item.

source

fn print_enum_def( &mut self, enum_definition: &EnumDef, generics: &Generics, ident: Ident, span: Span, visibility: &Visibility )

source

fn print_variants(&mut self, variants: &[Variant], span: Span)

source

pub(crate) fn print_visibility(&mut self, vis: &Visibility)

source

fn print_defaultness(&mut self, defaultness: Defaultness)

source

pub(crate) fn print_record_struct_body( &mut self, fields: &[FieldDef], span: Span )

source

fn print_struct( &mut self, struct_def: &VariantData, generics: &Generics, ident: Ident, span: Span, print_finalizer: bool )

source

pub(crate) fn print_variant(&mut self, v: &Variant)

source

fn print_assoc_item(&mut self, item: &AssocItem)

source

pub(crate) fn print_delegation( &mut self, attrs: &[Attribute], vis: &Visibility, qself: &Option<P<QSelf>>, path: &Path, suffixes: Option<&[(Ident, Option<Ident>)]>, body: &Option<P<Block>> )

source

fn print_fn_full( &mut self, sig: &FnSig, name: Ident, generics: &Generics, vis: &Visibility, defaultness: Defaultness, body: Option<&Block>, attrs: &[Attribute] )

source

pub(crate) fn print_fn( &mut self, decl: &FnDecl, header: FnHeader, name: Option<Ident>, generics: &Generics )

source

pub(crate) fn print_fn_params_and_ret( &mut self, decl: &FnDecl, is_closure: bool )

source

fn print_where_clause(&mut self, where_clause: &WhereClause)

source

fn print_where_clause_parts( &mut self, has_where_token: bool, predicates: &[WherePredicate] )

source

pub fn print_where_predicate(&mut self, predicate: &WherePredicate)

source

pub(crate) fn print_where_bound_predicate( &mut self, where_bound_predicate: &WhereBoundPredicate )

source

fn print_use_tree(&mut self, tree: &UseTree)

source§

impl<'a> State<'a>

source

pub fn new() -> State<'a>

source

fn commasep_cmnt<T, F, G>(&mut self, b: Breaks, elts: &[T], op: F, get_span: G)
where F: FnMut(&mut State<'_>, &T), G: FnMut(&T) -> Span,

source

fn commasep_exprs(&mut self, b: Breaks, exprs: &[P<Expr>])

source

pub fn print_opt_lifetime(&mut self, lifetime: &Option<Lifetime>)

source

pub fn print_assoc_constraint(&mut self, constraint: &AssocConstraint)

source

pub fn print_generic_arg(&mut self, generic_arg: &GenericArg)

source

pub fn print_type(&mut self, ty: &Ty)

source

fn print_trait_ref(&mut self, t: &TraitRef)

source

fn print_formal_generic_params(&mut self, generic_params: &[GenericParam])

source

fn print_poly_trait_ref(&mut self, t: &PolyTraitRef)

source

fn print_stmt(&mut self, st: &Stmt)

source

fn print_block(&mut self, blk: &Block)

source

fn print_block_unclosed_indent(&mut self, blk: &Block)

source

fn print_block_with_attrs(&mut self, blk: &Block, attrs: &[Attribute])

source

fn print_block_maybe_unclosed( &mut self, blk: &Block, attrs: &[Attribute], close_box: bool )

source

fn print_let(&mut self, pat: &Pat, expr: &Expr, fixup: FixupContext)

Print a let pat = expr expression.

Parentheses are inserted surrounding expr if a round-trip through the parser would otherwise work out the wrong way in a condition position.

For example each of the following would mean the wrong thing without parentheses.

if let _ = (Struct {}) {}

if let _ = (true && false) {}

In a match guard, the second case still requires parens, but the first case no longer does because anything until => is considered part of the match guard expression. Parsing of the expression is not terminated by { in that position.

match () {
    () if let _ = Struct {} => {}
    () if let _ = (true && false) => {}
}
source

fn print_mac(&mut self, m: &MacCall)

source

fn print_inline_asm(&mut self, asm: &InlineAsm)

source

fn print_local_decl(&mut self, loc: &Local)

source

fn print_name(&mut self, name: Symbol)

source

fn print_qpath( &mut self, path: &Path, qself: &QSelf, colons_before_params: bool )

source

fn print_pat(&mut self, pat: &Pat)

source

fn print_explicit_self(&mut self, explicit_self: &ExplicitSelf)

source

fn print_coroutine_kind(&mut self, coroutine_kind: CoroutineKind)

source

pub fn print_type_bounds(&mut self, bounds: &[GenericBound])

source

fn print_lifetime(&mut self, lifetime: Lifetime)

source

fn print_lifetime_bounds(&mut self, bounds: &GenericBounds)

source

fn print_generic_params(&mut self, generic_params: &[GenericParam])

source

pub fn print_mutability(&mut self, mutbl: Mutability, print_const: bool)

source

fn print_mt(&mut self, mt: &MutTy, print_const: bool)

source

fn print_param(&mut self, input: &Param, is_closure: bool)

source

fn print_fn_ret_ty(&mut self, fn_ret_ty: &FnRetTy)

source

fn print_ty_fn( &mut self, ext: Extern, unsafety: Unsafe, decl: &FnDecl, name: Option<Ident>, generic_params: &[GenericParam] )

source

fn print_fn_header_info(&mut self, header: FnHeader)

source

fn print_unsafety(&mut self, s: Unsafe)

source

fn print_constness(&mut self, s: Const)

source

fn print_is_auto(&mut self, s: IsAuto)

source

fn print_meta_item_lit(&mut self, lit: &MetaItemLit)

source

fn print_token_literal(&mut self, token_lit: Lit, span: Span)

source

fn print_symbol(&mut self, sym: Symbol, style: StrStyle)

source

fn print_inner_attributes_no_trailing_hardbreak( &mut self, attrs: &[Attribute] ) -> bool

source

fn print_outer_attributes_inline(&mut self, attrs: &[Attribute]) -> bool

source

fn print_attribute(&mut self, attr: &Attribute)

source

fn print_meta_list_item(&mut self, item: &NestedMetaItem)

source

fn print_meta_item(&mut self, item: &MetaItem)

source

pub(crate) fn bounds_to_string(&self, bounds: &[GenericBound]) -> String

source

pub(crate) fn where_bound_predicate_to_string( &self, where_bound_predicate: &WhereBoundPredicate ) -> String

source

pub(crate) fn tt_to_string(&self, tt: &TokenTree) -> String

source

pub(crate) fn tts_to_string(&self, tokens: &TokenStream) -> String

source

pub(crate) fn path_segment_to_string(&self, p: &PathSegment) -> String

source

pub(crate) fn meta_list_item_to_string(&self, li: &NestedMetaItem) -> String

source

pub(crate) fn attribute_to_string(&self, attr: &Attribute) -> String

Methods from Deref<Target = Printer>§

source

pub fn word_space<W: Into<Cow<'static, str>>>(&mut self, w: W)

source

pub fn popen(&mut self)

source

pub fn pclose(&mut self)

source

pub fn hardbreak_if_not_bol(&mut self)

source

pub fn space_if_not_bol(&mut self)

source

pub fn nbsp(&mut self)

source

pub fn word_nbsp<S: Into<Cow<'static, str>>>(&mut self, w: S)

source

pub fn synth_comment(&mut self, text: impl Into<Cow<'static, str>>)

Synthesizes a comment that was not textually present in the original source file.

source

pub fn rbox(&mut self, indent: isize, breaks: Breaks)

“raw box”

source

pub fn ibox(&mut self, indent: isize)

Inconsistent breaking box

source

pub fn cbox(&mut self, indent: isize)

Consistent breaking box

source

pub fn visual_align(&mut self)

source

pub fn break_offset(&mut self, n: usize, off: isize)

source

pub fn end(&mut self)

source

pub fn word<S: Into<Cow<'static, str>>>(&mut self, wrd: S)

source

fn spaces(&mut self, n: usize)

source

pub fn zerobreak(&mut self)

source

pub fn space(&mut self)

source

pub fn hardbreak(&mut self)

source

pub fn is_beginning_of_line(&self) -> bool

source

pub fn trailing_comma(&mut self)

source

pub fn trailing_comma_or_space(&mut self)

source

pub(crate) fn last_token(&self) -> Option<&Token>

source

pub(crate) fn last_token_still_buffered(&self) -> Option<&Token>

source

pub(crate) fn replace_last_token_still_buffered(&mut self, token: Token)

Be very careful with this!

source

fn scan_eof(&mut self)

source

fn scan_begin(&mut self, token: BeginToken)

source

fn scan_end(&mut self)

source

fn scan_break(&mut self, token: BreakToken)

source

fn scan_string(&mut self, string: Cow<'static, str>)

source

pub(crate) fn offset(&mut self, offset: isize)

source

fn check_stream(&mut self)

source

fn advance_left(&mut self)

source

fn check_stack(&mut self, depth: usize)

source

fn get_top(&self) -> PrintFrame

source

fn print_begin(&mut self, token: BeginToken, size: isize)

source

fn print_end(&mut self)

source

fn print_break(&mut self, token: BreakToken, size: isize)

source

fn print_string(&mut self, string: &str)

Trait Implementations§

source§

impl Deref for State<'_>

§

type Target = Printer

The resulting type after dereferencing.
source§

fn deref(&self) -> &Self::Target

Dereferences the value.
source§

impl DerefMut for State<'_>

source§

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.
source§

impl<'a> PrintState<'a> for State<'a>

source§

fn comments(&self) -> Option<&Comments<'a>>

source§

fn comments_mut(&mut self) -> Option<&mut Comments<'a>>

source§

fn ann_post(&mut self, ident: Ident)

source§

fn print_generic_args(&mut self, args: &GenericArgs, colons_before_params: bool)

source§

fn print_ident(&mut self, ident: Ident)

source§

fn strsep<T, F>( &mut self, sep: &'static str, space_before: bool, b: Breaks, elts: &[T], op: F )
where F: FnMut(&mut Self, &T),

source§

fn commasep<T, F>(&mut self, b: Breaks, elts: &[T], op: F)
where F: FnMut(&mut Self, &T),

source§

fn maybe_print_comment(&mut self, pos: BytePos) -> bool

source§

fn print_comment(&mut self, cmnt: Comment)

source§

fn peek_comment<'b>(&'b self) -> Option<&'b Comment>
where 'a: 'b,

source§

fn next_comment(&mut self) -> Option<Comment>

source§

fn maybe_print_trailing_comment( &mut self, span: Span, next_pos: Option<BytePos> )

source§

fn print_remaining_comments(&mut self)

source§

fn print_string(&mut self, st: &str, style: StrStyle)

source§

fn print_inner_attributes(&mut self, attrs: &[Attribute]) -> bool

source§

fn print_outer_attributes(&mut self, attrs: &[Attribute]) -> bool

source§

fn print_either_attributes( &mut self, attrs: &[Attribute], kind: AttrStyle, is_inline: bool, trailing_hardbreak: bool ) -> bool

source§

fn print_attribute_inline(&mut self, attr: &Attribute, is_inline: bool)

source§

fn print_attr_item(&mut self, item: &AttrItem, span: Span)

source§

fn print_tt(&mut self, tt: &TokenTree, convert_dollar_crate: bool) -> Spacing

This doesn’t deserve to be called “pretty” printing, but it should be meaning-preserving. A quick hack that might help would be to look at the spans embedded in the TTs to decide where to put spaces and newlines. But it’d be better to parse these according to the grammar of the appropriate macro, transcribe back into the grammar we just parsed from, and then pretty-print the resulting AST nodes (so, e.g., we print expression arguments as expressions). It can be done! I think.
source§

fn print_tts(&mut self, tts: &TokenStream, convert_dollar_crate: bool)

source§

fn print_mac_common( &mut self, header: Option<MacHeader<'_>>, has_bang: bool, ident: Option<Ident>, delim: Delimiter, tts: &TokenStream, convert_dollar_crate: bool, span: Span )

source§

fn print_mac_def( &mut self, macro_def: &MacroDef, ident: &Ident, sp: Span, print_visibility: impl FnOnce(&mut Self) )

source§

fn print_path(&mut self, path: &Path, colons_before_params: bool, depth: usize)

source§

fn print_path_segment( &mut self, segment: &PathSegment, colons_before_params: bool )

source§

fn head<S: Into<Cow<'static, str>>>(&mut self, w: S)

source§

fn bopen(&mut self)

source§

fn bclose_maybe_open(&mut self, span: Span, empty: bool, close_box: bool)

source§

fn bclose(&mut self, span: Span, empty: bool)

source§

fn break_offset_if_not_bol(&mut self, n: usize, off: isize)

source§

fn nonterminal_to_string(&self, nt: &Nonterminal) -> String

source§

fn token_kind_to_string(&self, tok: &TokenKind) -> Cow<'static, str>

Print the token kind precisely, without converting $crate into its respective crate name.
source§

fn token_kind_to_string_ext( &self, tok: &TokenKind, convert_dollar_crate: Option<Span> ) -> Cow<'static, str>

source§

fn token_to_string(&self, token: &Token) -> Cow<'static, str>

Print the token precisely, without converting $crate into its respective crate name.
source§

fn token_to_string_ext( &self, token: &Token, convert_dollar_crate: bool ) -> Cow<'static, str>

source§

fn ty_to_string(&self, ty: &Ty) -> String

source§

fn pat_to_string(&self, pat: &Pat) -> String

source§

fn expr_to_string(&self, e: &Expr) -> String

source§

fn meta_item_lit_to_string(&self, lit: &MetaItemLit) -> String

source§

fn stmt_to_string(&self, stmt: &Stmt) -> String

source§

fn item_to_string(&self, i: &Item) -> String

source§

fn path_to_string(&self, p: &Path) -> String

source§

fn vis_to_string(&self, v: &Visibility) -> String

source§

fn block_to_string(&self, blk: &Block) -> String

source§

fn attr_item_to_string(&self, ai: &AttrItem) -> String

source§

fn to_string(f: impl FnOnce(&mut State<'_>)) -> String

Auto Trait Implementations§

§

impl<'a> !DynSend for State<'a>

§

impl<'a> !DynSync for State<'a>

§

impl<'a> Freeze for State<'a>

§

impl<'a> !RefUnwindSafe for State<'a>

§

impl<'a> !Send for State<'a>

§

impl<'a> !Sync for State<'a>

§

impl<'a> Unpin for State<'a>

§

impl<'a> !UnwindSafe for State<'a>

Blanket Implementations§

source§

impl<T> Aligned for T

source§

const ALIGN: Alignment = _

Alignment of Self.
source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoEither for T

source§

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 more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
source§

impl<T> Pointable for T

source§

const ALIGN: usize = _

The alignment of pointer.
§

type Init = T

The type for initializers.
source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

impl<'a, T> Captures<'a> for T
where T: ?Sized,

Layout§

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 240 bytes