1 //! The `HirDisplay` trait, which serves two purposes: Turning various bits from
2 //! HIR back into source code, and just displaying them for debugging/testing
5 use std::fmt::{self, Debug};
8 use chalk_ir::BoundVar;
13 generics::TypeParamProvenance,
14 intern::{Internable, Interned},
16 path::{Path, PathKind},
17 type_ref::{TraitBoundModifier, TypeBound, TypeRef},
18 visibility::Visibility,
19 HasModule, ItemContainerId, Lookup, ModuleId, TraitId,
21 use hir_expand::{hygiene::Hygiene, name::Name};
22 use itertools::Itertools;
26 const_from_placeholder_idx,
28 from_assoc_type_id, from_foreign_def_id, from_placeholder_idx, lt_from_placeholder_idx,
30 primitive, subst_prefix, to_assoc_type_id,
31 utils::{self, generics},
32 AdtId, AliasEq, AliasTy, CallableDefId, CallableSig, Const, ConstValue, DomainGoal, GenericArg,
33 ImplTraitId, Interner, Lifetime, LifetimeData, LifetimeOutlives, Mutability, OpaqueTy,
34 ProjectionTy, ProjectionTyExt, QuantifiedWhereClause, Scalar, TraitRef, TraitRefExt, Ty, TyExt,
38 pub struct HirFormatter<'a> {
39 pub db: &'a dyn HirDatabase,
40 fmt: &'a mut dyn fmt::Write,
43 pub(crate) max_size: Option<usize>,
44 omit_verbose_types: bool,
45 display_target: DisplayTarget,
48 pub trait HirDisplay {
49 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError>;
51 /// Returns a `Display`able type that is human-readable.
52 fn into_displayable<'a>(
54 db: &'a dyn HirDatabase,
55 max_size: Option<usize>,
56 omit_verbose_types: bool,
57 display_target: DisplayTarget,
58 ) -> HirDisplayWrapper<'a, Self>
63 !matches!(display_target, DisplayTarget::SourceCode { .. }),
64 "HirDisplayWrapper cannot fail with DisplaySourceCodeError, use HirDisplay::hir_fmt directly instead"
66 HirDisplayWrapper { db, t: self, max_size, omit_verbose_types, display_target }
69 /// Returns a `Display`able type that is human-readable.
70 /// Use this for showing types to the user (e.g. diagnostics)
71 fn display<'a>(&'a self, db: &'a dyn HirDatabase) -> HirDisplayWrapper<'a, Self>
79 omit_verbose_types: false,
80 display_target: DisplayTarget::Diagnostics,
84 /// Returns a `Display`able type that is human-readable and tries to be succinct.
85 /// Use this for showing types to the user where space is constrained (e.g. doc popups)
86 fn display_truncated<'a>(
88 db: &'a dyn HirDatabase,
89 max_size: Option<usize>,
90 ) -> HirDisplayWrapper<'a, Self>
98 omit_verbose_types: true,
99 display_target: DisplayTarget::Diagnostics,
103 /// Returns a String representation of `self` that can be inserted into the given module.
104 /// Use this when generating code (e.g. assists)
105 fn display_source_code<'a>(
107 db: &'a dyn HirDatabase,
109 ) -> Result<String, DisplaySourceCodeError> {
110 let mut result = String::new();
111 match self.hir_fmt(&mut HirFormatter {
114 buf: String::with_capacity(20),
117 omit_verbose_types: false,
118 display_target: DisplayTarget::SourceCode { module_id },
121 Err(HirDisplayError::FmtError) => panic!("Writing to String can't fail!"),
122 Err(HirDisplayError::DisplaySourceCodeError(e)) => return Err(e),
127 /// Returns a String representation of `self` for test purposes
128 fn display_test<'a>(&'a self, db: &'a dyn HirDatabase) -> HirDisplayWrapper<'a, Self>
136 omit_verbose_types: false,
137 display_target: DisplayTarget::Test,
142 impl<'a> HirFormatter<'a> {
143 pub fn write_joined<T: HirDisplay>(
145 iter: impl IntoIterator<Item = T>,
147 ) -> Result<(), HirDisplayError> {
148 let mut first = true;
151 write!(self, "{}", sep)?;
155 // Abbreviate multiple omitted types with a single ellipsis.
156 if self.should_truncate() {
157 return write!(self, "{}", TYPE_HINT_TRUNCATION);
165 /// This allows using the `write!` macro directly with a `HirFormatter`.
166 pub fn write_fmt(&mut self, args: fmt::Arguments) -> Result<(), HirDisplayError> {
167 // We write to a buffer first to track output size
169 fmt::write(&mut self.buf, args)?;
170 self.curr_size += self.buf.len();
172 // Then we write to the internal formatter from the buffer
173 self.fmt.write_str(&self.buf).map_err(HirDisplayError::from)
176 pub fn should_truncate(&self) -> bool {
177 match self.max_size {
178 Some(max_size) => self.curr_size >= max_size,
183 pub fn omit_verbose_types(&self) -> bool {
184 self.omit_verbose_types
188 #[derive(Clone, Copy)]
189 pub enum DisplayTarget {
190 /// Display types for inlays, doc popups, autocompletion, etc...
191 /// Showing `{unknown}` or not qualifying paths is fine here.
192 /// There's no reason for this to fail.
194 /// Display types for inserting them in source files.
195 /// The generated code should compile, so paths need to be qualified.
196 SourceCode { module_id: ModuleId },
197 /// Only for test purpose to keep real types
202 fn is_source_code(&self) -> bool {
203 matches!(self, Self::SourceCode { .. })
205 fn is_test(&self) -> bool {
206 matches!(self, Self::Test)
211 pub enum DisplaySourceCodeError {
217 pub enum HirDisplayError {
218 /// Errors that can occur when generating source code
219 DisplaySourceCodeError(DisplaySourceCodeError),
220 /// `FmtError` is required to be compatible with std::fmt::Display
223 impl From<fmt::Error> for HirDisplayError {
224 fn from(_: fmt::Error) -> Self {
229 pub struct HirDisplayWrapper<'a, T> {
230 db: &'a dyn HirDatabase,
232 max_size: Option<usize>,
233 omit_verbose_types: bool,
234 display_target: DisplayTarget,
237 impl<'a, T> fmt::Display for HirDisplayWrapper<'a, T>
241 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
242 println!("formatting..");
243 match self.t.hir_fmt(&mut HirFormatter {
246 buf: String::with_capacity(20),
248 max_size: self.max_size,
249 omit_verbose_types: self.omit_verbose_types,
250 display_target: self.display_target,
253 Err(HirDisplayError::FmtError) => Err(fmt::Error),
254 Err(HirDisplayError::DisplaySourceCodeError(_)) => {
255 // This should never happen
256 panic!("HirDisplay::hir_fmt failed with DisplaySourceCodeError when calling Display::fmt!")
262 const TYPE_HINT_TRUNCATION: &str = "…";
264 impl<T: HirDisplay> HirDisplay for &'_ T {
265 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
266 HirDisplay::hir_fmt(*self, f)
270 impl<T: HirDisplay + Internable> HirDisplay for Interned<T> {
271 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
272 HirDisplay::hir_fmt(self.as_ref(), f)
276 impl HirDisplay for ProjectionTy {
277 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
278 if f.should_truncate() {
279 return write!(f, "{}", TYPE_HINT_TRUNCATION);
282 let trait_ = f.db.trait_data(self.trait_(f.db));
284 self.self_type_parameter(Interner).hir_fmt(f)?;
285 write!(f, " as {}", trait_.name)?;
286 if self.substitution.len(Interner) > 1 {
288 f.write_joined(&self.substitution.as_slice(Interner)[1..], ", ")?;
291 write!(f, ">::{}", f.db.type_alias_data(from_assoc_type_id(self.associated_ty_id)).name)?;
296 impl HirDisplay for OpaqueTy {
297 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
298 if f.should_truncate() {
299 return write!(f, "{}", TYPE_HINT_TRUNCATION);
302 self.substitution.at(Interner, 0).hir_fmt(f)
306 impl HirDisplay for GenericArg {
307 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
308 match self.interned() {
309 crate::GenericArgData::Ty(ty) => ty.hir_fmt(f),
310 crate::GenericArgData::Lifetime(lt) => lt.hir_fmt(f),
311 crate::GenericArgData::Const(c) => c.hir_fmt(f),
316 impl HirDisplay for Const {
317 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
318 let data = self.interned();
320 ConstValue::BoundVar(idx) => idx.hir_fmt(f),
321 ConstValue::InferenceVar(..) => write!(f, "_"),
322 ConstValue::Placeholder(idx) => {
323 let id = const_from_placeholder_idx(f.db, idx);
324 let generics = generics(f.db.upcast(), id.parent);
325 let param_data = &generics.params.consts[id.local_id];
326 write!(f, "{}", param_data.name)
328 ConstValue::Concrete(c) => write!(f, "{}", c.interned),
333 impl HirDisplay for BoundVar {
334 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
335 write!(f, "?{}.{}", self.debruijn.depth(), self.index)
339 impl HirDisplay for Ty {
340 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
341 if f.should_truncate() {
342 return write!(f, "{}", TYPE_HINT_TRUNCATION);
345 let interner_kind = self.kind(Interner);
346 println!("interner kind: {interner_kind:?}");
348 match self.kind(Interner) {
349 TyKind::Never => write!(f, "!")?,
350 TyKind::Str => write!(f, "str")?,
351 TyKind::Scalar(Scalar::Bool) => write!(f, "bool")?,
352 TyKind::Scalar(Scalar::Char) => write!(f, "char")?,
353 &TyKind::Scalar(Scalar::Float(t)) => write!(f, "{}", primitive::float_ty_to_string(t))?,
354 &TyKind::Scalar(Scalar::Int(t)) => write!(f, "{}", primitive::int_ty_to_string(t))?,
355 &TyKind::Scalar(Scalar::Uint(t)) => write!(f, "{}", primitive::uint_ty_to_string(t))?,
356 TyKind::Slice(t) => {
361 TyKind::Array(t, c) => {
368 TyKind::Raw(m, t) | TyKind::Ref(m, _, t) => {
369 if matches!(self.kind(Interner), TyKind::Raw(..)) {
374 Mutability::Not => "const ",
375 Mutability::Mut => "mut ",
383 Mutability::Not => "",
384 Mutability::Mut => "mut ",
389 // FIXME: all this just to decide whether to use parentheses...
390 let contains_impl_fn = |bounds: &[QuantifiedWhereClause]| {
391 bounds.iter().any(|bound| {
392 if let WhereClause::Implemented(trait_ref) = bound.skip_binders() {
393 let trait_ = trait_ref.hir_trait_id();
394 fn_traits(f.db.upcast(), trait_).any(|it| it == trait_)
400 let (preds_to_print, has_impl_fn_pred) = match t.kind(Interner) {
401 TyKind::Dyn(dyn_ty) if dyn_ty.bounds.skip_binders().interned().len() > 1 => {
402 let bounds = dyn_ty.bounds.skip_binders().interned();
403 (bounds.len(), contains_impl_fn(bounds))
405 TyKind::Alias(AliasTy::Opaque(OpaqueTy {
407 substitution: parameters,
409 | TyKind::OpaqueType(opaque_ty_id, parameters) => {
411 f.db.lookup_intern_impl_trait_id((*opaque_ty_id).into());
412 if let ImplTraitId::ReturnTypeImplTrait(func, idx) = impl_trait_id {
414 f.db.return_type_impl_traits(func)
415 .expect("impl trait id without data");
418 .map(|rpit| rpit.impl_traits[idx as usize].bounds.clone());
419 let bounds = data.substitute(Interner, parameters);
420 let mut len = bounds.skip_binders().len();
422 // Don't count Sized but count when it absent
423 // (i.e. when explicit ?Sized bound is set).
424 let default_sized = SizedByDefault::Sized {
425 anchor: func.lookup(f.db.upcast()).module(f.db.upcast()).krate(),
427 let sized_bounds = bounds
433 WhereClause::Implemented(trait_ref)
434 if default_sized.is_sized_trait(
435 trait_ref.hir_trait_id(),
444 len = len.saturating_sub(sized_bounds);
448 (len, contains_impl_fn(bounds.skip_binders()))
456 if has_impl_fn_pred && preds_to_print <= 2 {
460 if preds_to_print > 1 {
468 TyKind::Tuple(_, substs) => {
469 if substs.len(Interner) == 1 {
471 substs.at(Interner, 0).hir_fmt(f)?;
475 f.write_joined(&*substs.as_slice(Interner), ", ")?;
479 TyKind::Function(fn_ptr) => {
480 let sig = CallableSig::from_fn_ptr(fn_ptr);
483 TyKind::FnDef(def, parameters) => {
484 let def = from_chalk(f.db, *def);
485 let sig = f.db.callable_item_signature(def).substitute(Interner, parameters);
487 CallableDefId::FunctionId(ff) => {
488 write!(f, "fn {}", f.db.function_data(ff).name)?
490 CallableDefId::StructId(s) => write!(f, "{}", f.db.struct_data(s).name)?,
491 CallableDefId::EnumVariantId(e) => {
492 write!(f, "{}", f.db.enum_data(e.parent).variants[e.local_id].name)?
495 if parameters.len(Interner) > 0 {
496 let generics = generics(f.db.upcast(), def.into());
497 let (parent_params, self_param, type_params, _impl_trait_params) =
498 generics.provenance_split();
499 let total_len = parent_params + self_param + type_params;
500 // We print all params except implicit impl Trait params. Still a bit weird; should we leave out parent and self?
503 f.write_joined(¶meters.as_slice(Interner)[..total_len], ", ")?;
508 f.write_joined(sig.params(), ", ")?;
516 TyKind::Adt(AdtId(def_id), parameters) => {
517 match f.display_target {
518 DisplayTarget::Diagnostics | DisplayTarget::Test => {
519 let name = match *def_id {
520 hir_def::AdtId::StructId(it) => f.db.struct_data(it).name.clone(),
521 hir_def::AdtId::UnionId(it) => f.db.union_data(it).name.clone(),
522 hir_def::AdtId::EnumId(it) => f.db.enum_data(it).name.clone(),
524 write!(f, "{}", name)?;
526 DisplayTarget::SourceCode { module_id } => {
527 if let Some(path) = find_path::find_path(
529 ItemInNs::Types((*def_id).into()),
532 write!(f, "{}", path)?;
534 return Err(HirDisplayError::DisplaySourceCodeError(
535 DisplaySourceCodeError::PathNotFound,
541 if parameters.len(Interner) > 0 {
542 let parameters_to_write = if f.display_target.is_source_code()
543 || f.omit_verbose_types()
546 .as_generic_def(f.db)
547 .map(|generic_def_id| f.db.generic_defaults(generic_def_id))
548 .filter(|defaults| !defaults.is_empty())
550 None => parameters.as_slice(Interner),
551 Some(default_parameters) => {
552 let mut default_from = 0;
553 for (i, parameter) in parameters.iter(Interner).enumerate() {
555 parameter.assert_ty_ref(Interner).kind(Interner),
556 default_parameters.get(i),
558 (&TyKind::Error, _) | (_, None) => {
559 default_from = i + 1;
561 (_, Some(default_parameter)) => {
562 let actual_default = default_parameter
564 .substitute(Interner, &subst_prefix(parameters, i));
565 if parameter.assert_ty_ref(Interner) != &actual_default
567 default_from = i + 1;
572 ¶meters.as_slice(Interner)[0..default_from]
576 parameters.as_slice(Interner)
578 if !parameters_to_write.is_empty() {
581 if f.display_target.is_source_code() {
582 let mut first = true;
583 for generic_arg in parameters_to_write {
589 if generic_arg.ty(Interner).map(|ty| ty.kind(Interner))
590 == Some(&TyKind::Error)
594 generic_arg.hir_fmt(f)?;
598 f.write_joined(parameters_to_write, ", ")?;
605 TyKind::AssociatedType(assoc_type_id, parameters) => {
606 let type_alias = from_assoc_type_id(*assoc_type_id);
607 let trait_ = match type_alias.lookup(f.db.upcast()).container {
608 ItemContainerId::TraitId(it) => it,
609 _ => panic!("not an associated type"),
611 let trait_ = f.db.trait_data(trait_);
612 let type_alias_data = f.db.type_alias_data(type_alias);
614 // Use placeholder associated types when the target is test (https://rust-lang.github.io/chalk/book/clauses/type_equality.html#placeholder-associated-types)
615 if f.display_target.is_test() {
616 write!(f, "{}::{}", trait_.name, type_alias_data.name)?;
617 if parameters.len(Interner) > 0 {
619 f.write_joined(&*parameters.as_slice(Interner), ", ")?;
623 let projection_ty = ProjectionTy {
624 associated_ty_id: to_assoc_type_id(type_alias),
625 substitution: parameters.clone(),
628 projection_ty.hir_fmt(f)?;
631 TyKind::Foreign(type_alias) => {
632 let type_alias = f.db.type_alias_data(from_foreign_def_id(*type_alias));
633 write!(f, "{}", type_alias.name)?;
635 TyKind::OpaqueType(opaque_ty_id, parameters) => {
636 let impl_trait_id = f.db.lookup_intern_impl_trait_id((*opaque_ty_id).into());
637 match impl_trait_id {
638 ImplTraitId::ReturnTypeImplTrait(func, idx) => {
640 f.db.return_type_impl_traits(func).expect("impl trait id without data");
643 .map(|rpit| rpit.impl_traits[idx as usize].bounds.clone());
644 let bounds = data.substitute(Interner, ¶meters);
645 let krate = func.lookup(f.db.upcast()).module(f.db.upcast()).krate();
646 write_bounds_like_dyn_trait_with_prefix(
648 bounds.skip_binders(),
649 SizedByDefault::Sized { anchor: krate },
652 // FIXME: it would maybe be good to distinguish this from the alias type (when debug printing), and to show the substitution
654 ImplTraitId::AsyncBlockTypeImplTrait(..) => {
655 write!(f, "impl Future<Output = ")?;
656 parameters.at(Interner, 0).hir_fmt(f)?;
661 TyKind::Closure(.., substs) => {
662 if f.display_target.is_source_code() {
663 return Err(HirDisplayError::DisplaySourceCodeError(
664 DisplaySourceCodeError::Closure,
667 let sig = substs.at(Interner, 0).assert_ty_ref(Interner).callable_sig(f.db);
668 if let Some(sig) = sig {
669 if sig.params().is_empty() {
671 } else if f.should_truncate() {
672 write!(f, "|{}|", TYPE_HINT_TRUNCATION)?;
675 f.write_joined(sig.params(), ", ")?;
680 sig.ret().hir_fmt(f)?;
682 write!(f, "{{closure}}")?;
685 TyKind::Placeholder(idx) => {
686 let id = from_placeholder_idx(f.db, *idx);
687 let generics = generics(f.db.upcast(), id.parent);
688 let param_data = &generics.params.types[id.local_id];
689 match param_data.provenance {
690 TypeParamProvenance::TypeParamList | TypeParamProvenance::TraitSelf => {
691 write!(f, "{}", param_data.name.clone().unwrap_or_else(Name::missing))?
693 TypeParamProvenance::ArgumentImplTrait => {
694 let substs = generics.type_params_subst(f.db);
696 f.db.generic_predicates(id.parent)
698 .map(|pred| pred.clone().substitute(Interner, &substs))
699 .filter(|wc| match &wc.skip_binders() {
700 WhereClause::Implemented(tr) => {
701 &tr.self_type_parameter(Interner) == self
703 WhereClause::AliasEq(AliasEq {
704 alias: AliasTy::Projection(proj),
706 }) => &proj.self_type_parameter(Interner) == self,
709 .collect::<Vec<_>>();
710 let krate = id.parent.module(f.db.upcast()).krate();
711 write_bounds_like_dyn_trait_with_prefix(
714 SizedByDefault::Sized { anchor: krate },
720 TyKind::BoundVar(idx) => idx.hir_fmt(f)?,
721 TyKind::Dyn(dyn_ty) => {
722 write_bounds_like_dyn_trait_with_prefix(
724 dyn_ty.bounds.skip_binders().interned(),
725 SizedByDefault::NotSized,
729 TyKind::Alias(AliasTy::Projection(p_ty)) => p_ty.hir_fmt(f)?,
730 TyKind::Alias(AliasTy::Opaque(opaque_ty)) => {
731 let impl_trait_id = f.db.lookup_intern_impl_trait_id(opaque_ty.opaque_ty_id.into());
732 match impl_trait_id {
733 ImplTraitId::ReturnTypeImplTrait(func, idx) => {
735 f.db.return_type_impl_traits(func).expect("impl trait id without data");
738 .map(|rpit| rpit.impl_traits[idx as usize].bounds.clone());
739 let bounds = data.substitute(Interner, &opaque_ty.substitution);
740 let krate = func.lookup(f.db.upcast()).module(f.db.upcast()).krate();
741 write_bounds_like_dyn_trait_with_prefix(
743 bounds.skip_binders(),
744 SizedByDefault::Sized { anchor: krate },
748 ImplTraitId::AsyncBlockTypeImplTrait(..) => {
749 write!(f, "{{async block}}")?;
754 if f.display_target.is_source_code() {
755 return Err(HirDisplayError::DisplaySourceCodeError(
756 DisplaySourceCodeError::UnknownType,
759 write!(f, "{{unknown}}")?;
761 TyKind::InferenceVar(..) => write!(f, "_")?,
762 TyKind::Generator(..) => write!(f, "{{generator}}")?,
763 TyKind::GeneratorWitness(..) => write!(f, "{{generator witness}}")?,
769 impl HirDisplay for CallableSig {
770 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
772 f.write_joined(self.params(), ", ")?;
774 if self.params().is_empty() {
781 let ret = self.ret();
790 fn fn_traits(db: &dyn DefDatabase, trait_: TraitId) -> impl Iterator<Item = TraitId> {
791 let krate = trait_.lookup(db).container.krate();
792 utils::fn_traits(db, krate)
795 #[derive(Clone, Copy, PartialEq, Eq)]
796 pub enum SizedByDefault {
798 Sized { anchor: CrateId },
801 impl SizedByDefault {
802 fn is_sized_trait(self, trait_: TraitId, db: &dyn DefDatabase) -> bool {
804 Self::NotSized => false,
805 Self::Sized { anchor } => {
807 .lang_item(anchor, SmolStr::new_inline("sized"))
808 .and_then(|lang_item| lang_item.as_trait());
809 Some(trait_) == sized_trait
815 pub fn write_bounds_like_dyn_trait_with_prefix(
817 predicates: &[QuantifiedWhereClause],
818 default_sized: SizedByDefault,
819 f: &mut HirFormatter,
820 ) -> Result<(), HirDisplayError> {
821 write!(f, "{}", prefix)?;
822 if !predicates.is_empty()
823 || predicates.is_empty() && matches!(default_sized, SizedByDefault::Sized { .. })
826 write_bounds_like_dyn_trait(predicates, default_sized, f)
832 fn write_bounds_like_dyn_trait(
833 predicates: &[QuantifiedWhereClause],
834 default_sized: SizedByDefault,
835 f: &mut HirFormatter,
836 ) -> Result<(), HirDisplayError> {
837 // Note: This code is written to produce nice results (i.e.
838 // corresponding to surface Rust) for types that can occur in
839 // actual Rust. It will have weird results if the predicates
840 // aren't as expected (i.e. self types = $0, projection
841 // predicates for a certain trait come after the Implemented
842 // predicate for that trait).
843 let mut first = true;
844 let mut angle_open = false;
845 let mut is_fn_trait = false;
846 let mut is_sized = false;
847 for p in predicates.iter() {
848 match p.skip_binders() {
849 WhereClause::Implemented(trait_ref) => {
850 let trait_ = trait_ref.hir_trait_id();
851 if default_sized.is_sized_trait(trait_, f.db.upcast()) {
853 if matches!(default_sized, SizedByDefault::Sized { .. }) {
854 // Don't print +Sized, but rather +?Sized if absent.
859 is_fn_trait = fn_traits(f.db.upcast(), trait_).any(|it| it == trait_);
861 if !is_fn_trait && angle_open {
868 // We assume that the self type is ^0.0 (i.e. the
869 // existential) here, which is the only thing that's
870 // possible in actual Rust, and hence don't print it
871 write!(f, "{}", f.db.trait_data(trait_).name)?;
872 if let [_, params @ ..] = &*trait_ref.substitution.as_slice(Interner) {
875 params.first().and_then(|it| it.assert_ty_ref(Interner).as_tuple())
878 f.write_joined(args.as_slice(Interner), ", ")?;
881 } else if !params.is_empty() {
883 f.write_joined(params, ", ")?;
884 // there might be assoc type bindings, so we leave the angle brackets open
889 WhereClause::AliasEq(alias_eq) if is_fn_trait => {
891 if !alias_eq.ty.is_unit() {
893 alias_eq.ty.hir_fmt(f)?;
896 WhereClause::AliasEq(AliasEq { ty, alias }) => {
897 // in types in actual Rust, these will always come
898 // after the corresponding Implemented predicate
905 if let AliasTy::Projection(proj) = alias {
907 f.db.type_alias_data(from_assoc_type_id(proj.associated_ty_id));
908 write!(f, "{} = ", type_alias.name)?;
913 // FIXME implement these
914 WhereClause::LifetimeOutlives(_) => {}
915 WhereClause::TypeOutlives(_) => {}
922 if matches!(default_sized, SizedByDefault::Sized { .. }) {
924 write!(f, "{}?Sized", if first { "" } else { " + " })?;
932 fn fmt_trait_ref(tr: &TraitRef, f: &mut HirFormatter, use_as: bool) -> Result<(), HirDisplayError> {
933 if f.should_truncate() {
934 return write!(f, "{}", TYPE_HINT_TRUNCATION);
937 tr.self_type_parameter(Interner).hir_fmt(f)?;
943 write!(f, "{}", f.db.trait_data(tr.hir_trait_id()).name)?;
944 if tr.substitution.len(Interner) > 1 {
946 f.write_joined(&tr.substitution.as_slice(Interner)[1..], ", ")?;
952 impl HirDisplay for TraitRef {
953 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
954 fmt_trait_ref(self, f, false)
958 impl HirDisplay for WhereClause {
959 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
960 if f.should_truncate() {
961 return write!(f, "{}", TYPE_HINT_TRUNCATION);
965 WhereClause::Implemented(trait_ref) => trait_ref.hir_fmt(f)?,
966 WhereClause::AliasEq(AliasEq { alias: AliasTy::Projection(projection_ty), ty }) => {
968 fmt_trait_ref(&projection_ty.trait_ref(f.db), f, true)?;
972 f.db.type_alias_data(from_assoc_type_id(projection_ty.associated_ty_id)).name,
976 WhereClause::AliasEq(_) => write!(f, "{{error}}")?,
978 // FIXME implement these
979 WhereClause::TypeOutlives(..) => {}
980 WhereClause::LifetimeOutlives(..) => {}
986 impl HirDisplay for LifetimeOutlives {
987 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
994 impl HirDisplay for Lifetime {
995 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
996 self.interned().hir_fmt(f)
1000 impl HirDisplay for LifetimeData {
1001 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
1003 LifetimeData::BoundVar(idx) => idx.hir_fmt(f),
1004 LifetimeData::InferenceVar(_) => write!(f, "_"),
1005 LifetimeData::Placeholder(idx) => {
1006 let id = lt_from_placeholder_idx(f.db, *idx);
1007 let generics = generics(f.db.upcast(), id.parent);
1008 let param_data = &generics.params.lifetimes[id.local_id];
1009 write!(f, "{}", param_data.name)
1011 LifetimeData::Static => write!(f, "'static"),
1012 LifetimeData::Empty(_) => Ok(()),
1013 LifetimeData::Erased => Ok(()),
1014 LifetimeData::Phantom(_, _) => Ok(()),
1019 impl HirDisplay for DomainGoal {
1020 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
1022 DomainGoal::Holds(wc) => {
1023 write!(f, "Holds(")?;
1027 _ => write!(f, "?")?,
1033 pub fn write_visibility(
1034 module_id: ModuleId,
1036 f: &mut HirFormatter,
1037 ) -> Result<(), HirDisplayError> {
1039 Visibility::Public => write!(f, "pub "),
1040 Visibility::Module(vis_id) => {
1041 let def_map = module_id.def_map(f.db.upcast());
1042 let root_module_id = def_map.module_id(def_map.root());
1043 if vis_id == module_id {
1044 // pub(self) or omitted
1046 } else if root_module_id == vis_id {
1047 write!(f, "pub(crate) ")
1048 } else if module_id.containing_module(f.db.upcast()) == Some(vis_id) {
1049 write!(f, "pub(super) ")
1051 write!(f, "pub(in ...) ")
1057 impl HirDisplay for TypeRef {
1058 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
1060 TypeRef::Never => write!(f, "!")?,
1061 TypeRef::Placeholder => write!(f, "_")?,
1062 TypeRef::Tuple(elems) => {
1064 f.write_joined(elems, ", ")?;
1065 if elems.len() == 1 {
1070 TypeRef::Path(path) => path.hir_fmt(f)?,
1071 TypeRef::RawPtr(inner, mutability) => {
1072 let mutability = match mutability {
1073 hir_def::type_ref::Mutability::Shared => "*const ",
1074 hir_def::type_ref::Mutability::Mut => "*mut ",
1076 write!(f, "{}", mutability)?;
1079 TypeRef::Reference(inner, lifetime, mutability) => {
1080 let mutability = match mutability {
1081 hir_def::type_ref::Mutability::Shared => "",
1082 hir_def::type_ref::Mutability::Mut => "mut ",
1085 if let Some(lifetime) = lifetime {
1086 write!(f, "{} ", lifetime.name)?;
1088 write!(f, "{}", mutability)?;
1091 TypeRef::Array(inner, len) => {
1094 write!(f, "; {}]", len)?;
1096 TypeRef::Slice(inner) => {
1101 TypeRef::Fn(parameters, is_varargs) => {
1103 for index in 0..parameters.len() - 1 {
1104 let (param_name,param_type) = ¶meters[index];
1107 write!(f, "{}: ", name)?;
1108 param_type.hir_fmt(f)?;
1110 None => write!(f, " : {:?}", param_type)?,
1113 if index != parameters.len() - 2 {
1118 write!(f, "{}...", if parameters.len() == 1 { "" } else { ", " })?;
1121 let ret_ty = ¶meters.last().unwrap().1;
1123 TypeRef::Tuple(tup) if tup.is_empty() => {}
1130 TypeRef::ImplTrait(bounds) => {
1131 write!(f, "impl ")?;
1132 f.write_joined(bounds, " + ")?;
1134 TypeRef::DynTrait(bounds) => {
1136 f.write_joined(bounds, " + ")?;
1138 TypeRef::Macro(macro_call) => {
1139 let macro_call = macro_call.to_node(f.db.upcast());
1140 let ctx = body::LowerCtx::with_hygiene(f.db.upcast(), &Hygiene::new_unhygienic());
1141 match macro_call.path() {
1142 Some(path) => match Path::from_src(path, &ctx) {
1143 Some(path) => path.hir_fmt(f)?,
1144 None => write!(f, "{{macro}}")?,
1146 None => write!(f, "{{macro}}")?,
1148 write!(f, "!(..)")?;
1150 TypeRef::Error => write!(f, "{{error}}")?,
1156 impl HirDisplay for TypeBound {
1157 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
1159 TypeBound::Path(path, modifier) => {
1161 TraitBoundModifier::None => (),
1162 TraitBoundModifier::Maybe => write!(f, "?")?,
1166 TypeBound::Lifetime(lifetime) => write!(f, "{}", lifetime.name),
1167 TypeBound::ForLifetime(lifetimes, path) => {
1168 write!(f, "for<{}> ", lifetimes.iter().format(", "))?;
1171 TypeBound::Error => write!(f, "{{error}}"),
1176 impl HirDisplay for Path {
1177 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
1178 match (self.type_anchor(), self.kind()) {
1179 (Some(anchor), _) => {
1184 (_, PathKind::Plain) => {}
1185 (_, PathKind::Abs) => {}
1186 (_, PathKind::Crate) => write!(f, "crate")?,
1187 (_, PathKind::Super(0)) => write!(f, "self")?,
1188 (_, PathKind::Super(n)) => {
1193 write!(f, "super")?;
1196 (_, PathKind::DollarCrate(_)) => write!(f, "{{extern_crate}}")?,
1199 for (seg_idx, segment) in self.segments().iter().enumerate() {
1200 if !matches!(self.kind(), PathKind::Plain) || seg_idx > 0 {
1203 write!(f, "{}", segment.name)?;
1204 if let Some(generic_args) = segment.args_and_bindings {
1205 // We should be in type context, so format as `Foo<Bar>` instead of `Foo::<Bar>`.
1206 // Do we actually format expressions?
1207 if generic_args.desugared_from_fn {
1208 // First argument will be a tuple, which already includes the parentheses.
1209 // If the tuple only contains 1 item, write it manually to avoid the trailing `,`.
1210 if let hir_def::path::GenericArg::Type(TypeRef::Tuple(v)) =
1211 &generic_args.args[0]
1218 generic_args.args[0].hir_fmt(f)?;
1221 if let Some(ret) = &generic_args.bindings[0].type_ref {
1222 if !matches!(ret, TypeRef::Tuple(v) if v.is_empty()) {
1231 let mut first = true;
1232 for arg in &generic_args.args {
1235 if generic_args.has_self_type {
1236 // FIXME: Convert to `<Ty as Trait>` form.
1237 write!(f, "Self = ")?;
1244 for binding in &generic_args.bindings {
1250 write!(f, "{}", binding.name)?;
1251 match &binding.type_ref {
1258 f.write_joined(&binding.bounds, " + ")?;
1269 impl HirDisplay for hir_def::path::GenericArg {
1270 fn hir_fmt(&self, f: &mut HirFormatter) -> Result<(), HirDisplayError> {
1272 hir_def::path::GenericArg::Type(ty) => ty.hir_fmt(f),
1273 hir_def::path::GenericArg::Lifetime(lifetime) => write!(f, "{}", lifetime.name),