rustc_hir_pretty

Struct State

source
pub struct State<'a> {
    pub s: Printer,
    pub(crate) comments: Option<Comments<'a>>,
    pub(crate) attrs: &'a dyn Fn(HirId) -> &'a [Attribute],
    pub(crate) ann: &'a (dyn PpAnn + 'a),
}

Fields§

§s: Printer§comments: Option<Comments<'a>>§attrs: &'a dyn Fn(HirId) -> &'a [Attribute]§ann: &'a (dyn PpAnn + 'a)

Implementations§

source§

impl<'a> State<'a>

source

pub(crate) fn attrs(&self, id: HirId) -> &'a [Attribute]

source

pub(crate) fn print_node(&mut self, node: Node<'_>)

source§

impl<'a> State<'a>

source

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

source

pub(crate) fn bclose(&mut self, span: Span)

source

pub(crate) 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

pub(crate) fn commasep_exprs(&mut self, b: Breaks, exprs: &[Expr<'_>])

source

pub(crate) fn print_mod(&mut self, _mod: &Mod<'_>, attrs: &[Attribute])

source

pub(crate) fn print_opt_lifetime(&mut self, lifetime: &Lifetime)

source

pub(crate) fn print_type(&mut self, ty: &Ty<'_>)

source

pub(crate) fn print_foreign_item(&mut self, item: &ForeignItem<'_>)

source

pub(crate) fn print_associated_const( &mut self, ident: Ident, generics: &Generics<'_>, ty: &Ty<'_>, default: Option<BodyId>, )

source

pub(crate) fn print_associated_type( &mut self, ident: Ident, generics: &Generics<'_>, bounds: Option<GenericBounds<'_>>, ty: Option<&Ty<'_>>, )

source

pub(crate) fn print_item_type( &mut self, item: &Item<'_>, generics: &Generics<'_>, inner: impl Fn(&mut Self), )

source

pub(crate) fn print_item(&mut self, item: &Item<'_>)

source

pub(crate) fn print_trait_ref(&mut self, t: &TraitRef<'_>)

source

pub(crate) fn print_opaque_ty(&mut self, o: &OpaqueTy<'_>)

source

pub(crate) fn print_formal_generic_params( &mut self, generic_params: &[GenericParam<'_>], )

source

pub(crate) fn print_poly_trait_ref(&mut self, t: &PolyTraitRef<'_>)

source

pub(crate) fn print_enum_def( &mut self, enum_definition: &EnumDef<'_>, generics: &Generics<'_>, name: Symbol, span: Span, )

source

pub(crate) fn print_variants(&mut self, variants: &[Variant<'_>], span: Span)

source

pub(crate) fn print_defaultness(&mut self, defaultness: Defaultness)

source

pub(crate) fn print_struct( &mut self, struct_def: &VariantData<'_>, generics: &Generics<'_>, name: Symbol, span: Span, print_finalizer: bool, )

source

pub(crate) fn print_variant_struct( &mut self, span: Span, fields: &[FieldDef<'_>], )

source

pub fn print_variant(&mut self, v: &Variant<'_>)

source

pub(crate) fn print_method_sig( &mut self, ident: Ident, m: &FnSig<'_>, generics: &Generics<'_>, arg_names: &[Ident], body_id: Option<BodyId>, )

source

pub(crate) fn print_trait_item(&mut self, ti: &TraitItem<'_>)

source

pub(crate) fn print_impl_item(&mut self, ii: &ImplItem<'_>)

source

pub(crate) fn print_local( &mut self, init: Option<&Expr<'_>>, els: Option<&Block<'_>>, decl: impl Fn(&mut Self), )

source

pub(crate) fn print_stmt(&mut self, st: &Stmt<'_>)

source

pub(crate) fn print_block(&mut self, blk: &Block<'_>)

source

pub(crate) fn print_block_unclosed(&mut self, blk: &Block<'_>)

source

pub(crate) fn print_block_with_attrs( &mut self, blk: &Block<'_>, attrs: &[Attribute], )

source

pub(crate) fn print_block_maybe_unclosed( &mut self, blk: &Block<'_>, attrs: &[Attribute], close_box: bool, )

source

pub(crate) fn print_else(&mut self, els: Option<&Expr<'_>>)

source

pub(crate) fn print_if( &mut self, test: &Expr<'_>, blk: &Expr<'_>, elseopt: Option<&Expr<'_>>, )

source

pub(crate) fn print_array_length(&mut self, len: &ArrayLen<'_>)

source

pub(crate) fn print_anon_const(&mut self, constant: &AnonConst)

source

pub(crate) fn print_const_arg(&mut self, const_arg: &ConstArg<'_>)

source

pub(crate) fn print_call_post(&mut self, args: &[Expr<'_>])

source

pub(crate) fn print_expr_maybe_paren(&mut self, expr: &Expr<'_>, prec: i8)

source

pub(crate) 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

pub(crate) fn print_expr_cond_paren(&mut self, expr: &Expr<'_>, needs_par: bool)

Prints expr or (expr) when needs_par holds.

source

pub(crate) fn print_let( &mut self, pat: &Pat<'_>, ty: Option<&Ty<'_>>, init: &Expr<'_>, )

Print a let pat = expr expression.

source

pub(crate) fn cond_needs_par(expr: &Expr<'_>) -> bool

source

pub(crate) fn print_expr_vec(&mut self, exprs: &[Expr<'_>])

source

pub(crate) fn print_inline_const(&mut self, constant: &ConstBlock)

source

pub(crate) fn print_expr_repeat( &mut self, element: &Expr<'_>, count: &ArrayLen<'_>, )

source

pub(crate) fn print_expr_struct( &mut self, qpath: &QPath<'_>, fields: &[ExprField<'_>], wth: Option<&Expr<'_>>, )

source

pub(crate) fn print_expr_field(&mut self, field: &ExprField<'_>)

source

pub(crate) fn print_expr_tup(&mut self, exprs: &[Expr<'_>])

source

pub(crate) fn print_expr_call(&mut self, func: &Expr<'_>, args: &[Expr<'_>])

source

pub(crate) fn print_expr_method_call( &mut self, segment: &PathSegment<'_>, receiver: &Expr<'_>, args: &[Expr<'_>], )

source

pub(crate) fn print_expr_binary( &mut self, op: BinOp, lhs: &Expr<'_>, rhs: &Expr<'_>, )

source

pub(crate) fn print_expr_unary(&mut self, op: UnOp, expr: &Expr<'_>)

source

pub(crate) fn print_expr_addr_of( &mut self, kind: BorrowKind, mutability: Mutability, expr: &Expr<'_>, )

source

pub(crate) fn print_literal(&mut self, lit: &Lit)

source

pub(crate) fn print_inline_asm(&mut self, asm: &InlineAsm<'_>)

source

pub(crate) fn print_expr(&mut self, expr: &Expr<'_>)

source

pub(crate) fn print_local_decl(&mut self, loc: &LetStmt<'_>)

source

pub(crate) fn print_name(&mut self, name: Symbol)

source

pub(crate) fn print_path<R>( &mut self, path: &Path<'_, R>, colons_before_params: bool, )

source

pub(crate) fn print_path_segment(&mut self, segment: &PathSegment<'_>)

source

pub(crate) fn print_qpath( &mut self, qpath: &QPath<'_>, colons_before_params: bool, )

source

pub(crate) fn print_generic_args( &mut self, generic_args: &GenericArgs<'_>, colons_before_params: bool, )

source

pub(crate) fn print_assoc_item_constraint( &mut self, constraint: &AssocItemConstraint<'_>, )

source

pub(crate) fn print_pat(&mut self, pat: &Pat<'_>)

source

pub(crate) fn print_patfield(&mut self, field: &PatField<'_>)

source

pub(crate) fn print_param(&mut self, arg: &Param<'_>)

source

pub(crate) fn print_arm(&mut self, arm: &Arm<'_>)

source

pub(crate) fn print_fn( &mut self, decl: &FnDecl<'_>, header: FnHeader, name: Option<Symbol>, generics: &Generics<'_>, arg_names: &[Ident], body_id: Option<BodyId>, )

source

pub(crate) fn print_closure_params( &mut self, decl: &FnDecl<'_>, body_id: BodyId, )

source

pub(crate) fn print_capture_clause(&mut self, capture_clause: CaptureBy)

source

pub(crate) fn print_closure_binder( &mut self, binder: ClosureBinder, generic_params: &[GenericParam<'_>], )

source

pub(crate) fn print_bounds<'b>( &mut self, prefix: &'static str, bounds: impl IntoIterator<Item = &'b GenericBound<'b>>, )

source

pub(crate) fn print_precise_capturing_arg( &mut self, arg: PreciseCapturingArg<'_>, )

source

pub(crate) fn print_generic_params( &mut self, generic_params: &[GenericParam<'_>], )

source

pub(crate) fn print_generic_param(&mut self, param: &GenericParam<'_>)

source

pub(crate) fn print_lifetime(&mut self, lifetime: &Lifetime)

source

pub(crate) fn print_where_clause(&mut self, generics: &Generics<'_>)

source

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

source

pub(crate) fn print_mt(&mut self, mt: &MutTy<'_>, print_const: bool)

source

pub(crate) fn print_fn_output(&mut self, decl: &FnDecl<'_>)

source

pub(crate) fn print_ty_fn( &mut self, abi: Abi, safety: Safety, decl: &FnDecl<'_>, name: Option<Symbol>, generic_params: &[GenericParam<'_>], arg_names: &[Ident], )

source

pub(crate) fn print_fn_header_info(&mut self, header: FnHeader)

source

pub(crate) fn print_constness(&mut self, s: Constness)

source

pub(crate) fn print_safety(&mut self, s: Safety)

source

pub(crate) fn print_is_auto(&mut self, s: IsAuto)

Methods from Deref<Target = Printer>§

source

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

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>(&mut self, w: S)
where S: Into<Cow<'static, str>>,

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>(&mut self, wrd: S)
where S: Into<Cow<'static, str>>,

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)

Trait Implementations§

source§

impl Deref for State<'_>

source§

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, _: &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>(&mut self, w: S)
where S: Into<Cow<'static, str>>,

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 tts_to_string(&self, tokens: &TokenStream) -> String

source§

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

Auto Trait Implementations§

§

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> Same for T

source§

type Output = T

Should always be Self
source§

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

source§

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>,

source§

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<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

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: 256 bytes