Module pretty

Source

MacrosΒ§

define_helper πŸ”’
define_print πŸ”’
define_print_and_forward_display πŸ”’
define_scoped_cx πŸ”’
forward_display_to_print πŸ”’
p πŸ”’
with_crate_prefix
Adds the crate:: prefix to paths where appropriate.
with_forced_impl_filename_line
Force us to name impls with just the filename/line number. We normally try to use types. But at some points, notably while printing cycle errors, this can result in extra or suboptimal error output, so this variable disables that check.
with_forced_trimmed_paths
with_no_queries
Avoids running any queries during prints.
with_no_trimmed_paths
Prevent path trimming if it is turned on. Path trimming affects Display impl of various rustc types, for example std::vec::Vec would be trimmed to Vec, if no other Vec is found.
with_no_visible_paths
Prevent selection of visible paths. Display impl of DefId will prefer visible (public) reexports of types as paths.
with_no_visible_paths_if_doc_hidden
Prevent selection of visible paths if the paths are through a doc hidden path.
with_reduced_queries
Avoids running select queries during any prints that occur during the closure. This may alter the appearance of some types (e.g. forcing verbose printing for opaque types). This method is used during some queries (e.g. explicit_item_bounds for opaque types), to ensure that any debug printing that occurs during the query computation does not end up recursively calling the same query.
with_types_for_signature
Print types for the purposes of a signature suggestion.
with_types_for_suggestion
Print types for the purposes of a suggestion.

StructsΒ§

CratePrefixGuard
FmtPrinter
FmtPrinterData
ForceTrimmedGuard
ForcedImplGuard
NoTrimmedGuard
NoVisibleGuard
NoVisibleIfDocHiddenGuard
OpaqueFnEntry
PrintClosureAsImpl
ReducedQueriesGuard
RegionFolder πŸ”’
Folds through bound vars and placeholders, naming them
RegionHighlightMode
The β€œregion highlights” are used to control region printing during specific error messages. When a β€œregion highlight” is enabled, it gives an alternate way to print specific regions. For now, we always print those regions using a number, so something like β€œ'0”.
RtnModeHelper
TraitPredPrintModifiersAndPath
TraitPredPrintWithBoundConstness
TraitRefPrintOnlyTraitName
Wrapper type for ty::TraitRef which opts-in to pretty printing only the trait name. That is, it will print Trait instead of <T as Trait<U>>.
TraitRefPrintOnlyTraitPath
Wrapper type for ty::TraitRef which opts-in to pretty printing only the trait path. That is, it will print Trait<U> instead of <T as Trait<U>>.
TraitRefPrintSugared
Wrapper type for ty::TraitRef which opts-in to pretty printing only the trait path, and additionally tries to β€œsugar” Fn(...) trait bounds.

EnumsΒ§

RtnMode
Rendering style for RTN types.
WrapBinderMode

ConstantsΒ§

FORCE_IMPL_FILENAME_LINE πŸ”’
FORCE_TRIMMED_PATH πŸ”’
NO_TRIMMED_PATH πŸ”’
NO_VISIBLE_PATH πŸ”’
NO_VISIBLE_PATH_IF_DOC_HIDDEN πŸ”’
REDUCED_QUERIES πŸ”’
RTN_MODE πŸ”’
SHOULD_PREFIX_WITH_CRATE πŸ”’

TraitsΒ§

PrettyPrinter
Trait for printers that pretty-print using fmt::Write to the printer.
PrintPolyTraitPredicateExt
PrintPolyTraitRefExt
PrintTraitPredicateExt
PrintTraitRefExt

FunctionsΒ§

for_each_def πŸ”’
guess_def_namespace πŸ”’
pretty_print_const πŸ”’
provide
trimmed_def_paths
The purpose of this function is to collect public symbols names that are unique across all crates in the build. Later, when printing about types we can use those names instead of the full exported path to them.
with_crate_prefix
with_forced_impl_filename_line
with_forced_trimmed_paths
with_no_trimmed_paths
with_no_visible_paths
with_no_visible_paths_if_doc_hidden
with_reduced_queries