Document associated_item methods

spastorino · spastorino · commit 5e763b662470 · 2023-02-19T11:58:48.000-03:00
diff --git a/compiler/rustc_middle/src/query/mod.rs b/compiler/rustc_middle/src/query/mod.rs
@@ -767,7 +767,12 @@ rustc_queries! {
         desc { |tcx| "comparing impl items against trait for `{}`", tcx.def_path_str(impl_id) }
     }
 
-    /// Given an `fn_def_id`, create and return the associated items for that function.
+    /// Given `fn_def_id` of a trait or of an impl that implements a given trait:
+    /// if `fn_def_id` is the def id of a function defined inside a trait, then it creates and returns
+    /// the associated items that correspond to each impl trait in return position for that trait.
+    /// if `fn_def_id` is the def id of a function defined inside an impl that implements a trait, then it
+    /// creates and returns the associated items that correspond to each impl trait in return position
+    /// of the implemented trait.
     query associated_items_for_impl_trait_in_trait(fn_def_id: DefId) -> &'tcx [DefId] {
         desc { |tcx| "creating associated items for impl trait in trait returned by `{}`", tcx.def_path_str(fn_def_id) }
         cache_on_disk_if { fn_def_id.is_local() }
diff --git a/compiler/rustc_ty_utils/src/assoc.rs b/compiler/rustc_ty_utils/src/assoc.rs
@@ -118,6 +118,12 @@ fn associated_item_from_impl_item_ref(impl_item_ref: &hir::ImplItemRef) -> ty::A
     }
 }
 
+/// Given an `fn_def_id` of a trait or of an impl that implements a given trait:
+/// if `fn_def_id` is the def id of a function defined inside a trait, then it creates and returns
+/// the associated items that correspond to each impl trait in return position for that trait.
+/// if `fn_def_id` is the def id of a function defined inside an impl that implements a trait, then it
+/// creates and returns the associated items that correspond to each impl trait in return position
+/// of the implemented trait.
 fn associated_items_for_impl_trait_in_trait(tcx: TyCtxt<'_>, fn_def_id: DefId) -> &'_ [DefId] {
     let parent_def_id = tcx.parent(fn_def_id);
 
@@ -174,6 +180,8 @@ fn associated_items_for_impl_trait_in_trait(tcx: TyCtxt<'_>, fn_def_id: DefId) -
     }
 }
 
+/// Given an `opaque_ty_def_id` corresponding to an impl trait in trait, create and return the
+/// corresponding associated item.
 fn associated_item_for_impl_trait_in_trait(
     tcx: TyCtxt<'_>,
     opaque_ty_def_id: LocalDefId,
@@ -188,6 +196,9 @@ fn associated_item_for_impl_trait_in_trait(
     trait_assoc_ty.def_id()
 }
 
+/// Given an `trait_assoc_def_id` that corresponds to a previously synthethized impl trait in trait
+/// into an associated type and an `impl_def_id` corresponding to an impl block, create and return
+/// the corresponding associated item inside the impl block.
 fn impl_associated_item_for_impl_trait_in_trait(
     tcx: TyCtxt<'_>,
     trait_assoc_def_id: LocalDefId,

Original file line number	Diff line number	Diff line change
`@@ -118,6 +118,12 @@ fn associated_item_from_impl_item_ref(impl_item_ref: &hir::ImplItemRef) -> ty::A`
`118`	`118`	`}`
`119`	`119`	`}`
`120`	`120`
	`121`	+/// Given an `fn_def_id` of a trait or of an impl that implements a given trait:
	`122`	+/// if `fn_def_id` is the def id of a function defined inside a trait, then it creates and returns
	`123`	`+/// the associated items that correspond to each impl trait in return position for that trait.`
	`124`	+/// if `fn_def_id` is the def id of a function defined inside an impl that implements a trait, then it
	`125`	`+/// creates and returns the associated items that correspond to each impl trait in return position`
	`126`	`+/// of the implemented trait.`
`121`	`127`	`fn associated_items_for_impl_trait_in_trait(tcx: TyCtxt<'_>, fn_def_id: DefId) -> &'_ [DefId] {`
`122`	`128`	`let parent_def_id = tcx.parent(fn_def_id);`
`123`	`129`
`@@ -174,6 +180,8 @@ fn associated_items_for_impl_trait_in_trait(tcx: TyCtxt<'_>, fn_def_id: DefId) -`
`174`	`180`	`}`
`175`	`181`	`}`
`176`	`182`
	`183`	+/// Given an `opaque_ty_def_id` corresponding to an impl trait in trait, create and return the
	`184`	`+/// corresponding associated item.`
`177`	`185`	`fn associated_item_for_impl_trait_in_trait(`
`178`	`186`	`tcx: TyCtxt<'_>,`
`179`	`187`	`opaque_ty_def_id: LocalDefId,`
`@@ -188,6 +196,9 @@ fn associated_item_for_impl_trait_in_trait(`
`188`	`196`	`trait_assoc_ty.def_id()`
`189`	`197`	`}`
`190`	`198`
	`199`	+/// Given an `trait_assoc_def_id` that corresponds to a previously synthethized impl trait in trait
	`200`	+/// into an associated type and an `impl_def_id` corresponding to an impl block, create and return
	`201`	`+/// the corresponding associated item inside the impl block.`
`191`	`202`	`fn impl_associated_item_for_impl_trait_in_trait(`
`192`	`203`	`tcx: TyCtxt<'_>,`
`193`	`204`	`trait_assoc_def_id: LocalDefId,`