Struct rustc_middle::ty::print::pretty::FmtPrinter

pub struct FmtPrinter<'a, 'tcx, F>(Box<FmtPrinterData<'a, 'tcx, F>>);

Implementations

impl<F, 'a, 'tcx> FmtPrinter<'a, 'tcx, F>

pub fn new(tcx: TyCtxt<'tcx>, fmt: F, ns: Namespace) -> Self

impl<F: Write, '_, '_> FmtPrinter<'_, '_, F>

pub fn pretty_print_region(self, region: Region<'_>) -> Result<Self, Error>

impl<F: Write, '_, 'tcx> FmtPrinter<'_, 'tcx, F>

pub fn name_all_regions<T>(
    self,
    value: &Binder<T>
) -> Result<(Self, (T, BTreeMap<BoundRegion, Region<'tcx>>)), Error> where
    T: Print<'tcx, Self, Output = Self, Error = Error> + TypeFoldable<'tcx>, 

pub fn pretty_in_binder<T>(self, value: &Binder<T>) -> Result<Self, Error> where
    T: Print<'tcx, Self, Output = Self, Error = Error> + TypeFoldable<'tcx>, 

pub(in ty::print::pretty) fn prepare_late_bound_region_info<T>(
    &mut self,
    value: &Binder<T>
) where
    T: TypeFoldable<'tcx>, 

Trait Implementations

impl<F, 'a, 'tcx> Deref for FmtPrinter<'a, 'tcx, F>

type Target = FmtPrinterData<'a, 'tcx, F>

The resulting type after dereferencing.

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

Dereferences the value.

impl<F, '_, '_> DerefMut for FmtPrinter<'_, '_, F>

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

Mutably dereferences the value.

impl<F: Write, 'tcx, '_> PrettyPrinter<'tcx> for FmtPrinter<'_, 'tcx, F>

pub fn infer_ty_name(&self, id: TyVid) -> Option<String>

pub fn print_value_path(
    self,
    def_id: DefId,
    substs: &'tcx [GenericArg<'tcx>]
) -> Result<Self::Path, Self::Error>

Like print_def_path but for value paths.

pub fn in_binder<T>(self, value: &Binder<T>) -> Result<Self, Self::Error> where
    T: Print<'tcx, Self, Output = Self, Error = Self::Error> + TypeFoldable<'tcx>, 

pub fn typed_value(
    self,
    f: impl FnOnce(Self) -> Result<Self, Self::Error>,
    t: impl FnOnce(Self) -> Result<Self, Self::Error>,
    conversion: &str
) -> Result<Self::Const, Self::Error>

Prints {f: t} or {f as t} depending on the cast argument

pub fn generic_delimiters(
    self,
    f: impl FnOnce(Self) -> Result<Self, Self::Error>
) -> Result<Self, Self::Error>

Prints <...> around what f prints.

pub fn region_should_not_be_omitted(&self, region: Region<'_>) -> bool

Returns true if the region should be printed in optional positions, e.g., &'a T or dyn Tr + 'b. This is typically the case for all non-'_ regions.

pub fn pretty_print_const_pointer(
    self,
    p: Pointer,
    ty: Ty<'tcx>,
    print_ty: bool
) -> Result<Self::Const, Self::Error>

This is overridden for MIR printing because we only want to hide alloc ids from users, not from MIR where it is actually useful.

pub fn comma_sep<T>(
    self,
    elems: impl Iterator<Item = T>
) -> Result<Self, Self::Error> where
    T: Print<'tcx, Self, Output = Self, Error = Self::Error>, 

Prints comma-separated elements.

pub fn try_print_visible_def_path(
    self,
    def_id: DefId
) -> Result<(Self, bool), Self::Error>

If possible, this returns a global path resolving to def_id that is visible from at least one local module, and returns true. If the crate defining def_id is declared with an extern crate, the path is guaranteed to use the extern crate.

pub fn try_print_trimmed_def_path(
    self,
    def_id: DefId
) -> Result<(Self::Path, bool), Self::Error>

Try to see if this path can be trimmed to a unique symbol name.

pub fn try_print_visible_def_path_recur(
    self,
    def_id: DefId,
    callers: &mut Vec<DefId>
) -> Result<(Self, bool), Self::Error>

Does the work of try_print_visible_def_path, building the full definition path recursively before attempting to post-process it into the valid and visible version that accounts for re-exports.

pub fn pretty_path_qualified(
    self,
    self_ty: Ty<'tcx>,
    trait_ref: Option<TraitRef<'tcx>>
) -> Result<Self::Path, Self::Error>

pub fn pretty_path_append_impl(
    self,
    print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
    self_ty: Ty<'tcx>,
    trait_ref: Option<TraitRef<'tcx>>
) -> Result<Self::Path, Self::Error>

pub fn pretty_print_type(self, ty: Ty<'tcx>) -> Result<Self::Type, Self::Error>

pub fn pretty_print_bound_var(
    &mut self,
    debruijn: DebruijnIndex,
    var: BoundVar
) -> Result<(), Self::Error>

pub fn pretty_print_dyn_existential(
    self,
    predicates: &'tcx List<ExistentialPredicate<'tcx>>
) -> Result<Self::DynExistential, Self::Error>

pub fn pretty_fn_sig(
    self,
    inputs: &[Ty<'tcx>],
    c_variadic: bool,
    output: Ty<'tcx>
) -> Result<Self, Self::Error>

pub fn pretty_print_const(
    self,
    ct: &'tcx Const<'tcx>,
    print_ty: bool
) -> Result<Self::Const, Self::Error>

pub fn pretty_print_const_scalar(
    self,
    scalar: Scalar,
    ty: Ty<'tcx>,
    print_ty: bool
) -> Result<Self::Const, Self::Error>

pub fn pretty_print_byte_str(
    self,
    byte_str: &'tcx [u8]
) -> Result<Self::Const, Self::Error>

pub fn pretty_print_const_value(
    self,
    ct: ConstValue<'tcx>,
    ty: Ty<'tcx>,
    print_ty: bool
) -> Result<Self::Const, Self::Error>

impl<F: Write, 'tcx, '_> Printer<'tcx> for FmtPrinter<'_, 'tcx, F>

type Error = Error

type Path = Self

type Region = Self

type Type = Self

type DynExistential = Self

type Const = Self

pub fn tcx<'a>(&'a self) -> TyCtxt<'tcx>

pub fn print_def_path(
    self,
    def_id: DefId,
    substs: &'tcx [GenericArg<'tcx>]
) -> Result<Self::Path, Self::Error>

pub fn print_region(
    self,
    region: Region<'_>
) -> Result<Self::Region, Self::Error>

pub fn print_type(self, ty: Ty<'tcx>) -> Result<Self::Type, Self::Error>

pub fn print_dyn_existential(
    self,
    predicates: &'tcx List<ExistentialPredicate<'tcx>>
) -> Result<Self::DynExistential, Self::Error>

pub fn print_const(
    self,
    ct: &'tcx Const<'tcx>
) -> Result<Self::Const, Self::Error>

pub fn path_crate(self, cnum: CrateNum) -> Result<Self::Path, Self::Error>

pub fn path_qualified(
    self,
    self_ty: Ty<'tcx>,
    trait_ref: Option<TraitRef<'tcx>>
) -> Result<Self::Path, Self::Error>

pub fn path_append_impl(
    self,
    print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
    _disambiguated_data: &DisambiguatedDefPathData,
    self_ty: Ty<'tcx>,
    trait_ref: Option<TraitRef<'tcx>>
) -> Result<Self::Path, Self::Error>

pub fn path_append(
    self,
    print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
    disambiguated_data: &DisambiguatedDefPathData
) -> Result<Self::Path, Self::Error>

pub fn path_generic_args(
    self,
    print_prefix: impl FnOnce(Self) -> Result<Self::Path, Self::Error>,
    args: &[GenericArg<'tcx>]
) -> Result<Self::Path, Self::Error>

pub fn print_impl_path(
    self,
    impl_def_id: DefId,
    substs: &'tcx [GenericArg<'tcx>],
    self_ty: Ty<'tcx>,
    trait_ref: Option<TraitRef<'tcx>>
) -> Result<Self::Path, Self::Error>

pub fn default_print_def_path(
    self,
    def_id: DefId,
    substs: &'tcx [GenericArg<'tcx>]
) -> Result<Self::Path, Self::Error>

pub fn generic_args_to_print(
    &self,
    generics: &'tcx Generics,
    substs: &'tcx [GenericArg<'tcx>]
) -> &'tcx [GenericArg<'tcx>]

pub fn default_print_impl_path(
    self,
    impl_def_id: DefId,
    _substs: &'tcx [GenericArg<'tcx>],
    self_ty: Ty<'tcx>,
    impl_trait_ref: Option<TraitRef<'tcx>>
) -> Result<Self::Path, Self::Error>

impl<F: Write, '_, '_> Write for FmtPrinter<'_, '_, F>

pub fn write_str(&mut self, s: &str) -> Result

Writes a string slice into this writer, returning whether the write succeeded.

pub fn write_char(&mut self, c: char) -> Result<(), Error>

Writes a char into this writer, returning whether the write succeeded.

pub fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Glue for usage of the write! macro with implementors of this trait.