mikros/rust
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Rollup merge of #132608 - mejrs:type_impls_trait, r=compiler-errors

Browse Source 
document `type_implements_trait`

Rendered:

![image](https://github.com/user-attachments/assets/60c00e50-24fd-4b04-bb22-e71b479c0b29)

r? `@compiler-errors`
This commit is contained in:
Jubilee 2024-11-04 20:40:49 -08:00 committed by GitHub
commit 33ebfff83a
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
compiler/rustc_trait_selection/src/infer.rs
View File

@ -60,6 +60,24 @@ fn type_is_sized_modulo_regions(&self, param_env: ty::ParamEnv<'tcx>, ty: Ty<'tc
/// ///
/// Invokes `evaluate_obligation`, so in the event that evaluating /// Invokes `evaluate_obligation`, so in the event that evaluating
/// `Ty: Trait` causes overflow, EvaluatedToAmbigStackDependent will be returned. /// `Ty: Trait` causes overflow, EvaluatedToAmbigStackDependent will be returned.
///
/// `type_implements_trait` is a convenience function for simple cases like
///
/// ```ignore (illustrative)
/// let copy_trait = infcx.tcx.require_lang_item(LangItem::Copy, span);
/// let implements_copy = infcx.type_implements_trait(copy_trait, [ty], param_env)
/// .must_apply_modulo_regions();
/// ```
///
/// In most cases you should instead create an [Obligation] and check whether
/// it holds via [`evaluate_obligation`] or one of its helper functions like
/// [`predicate_must_hold_modulo_regions`], because it properly handles higher ranked traits
/// and it is more convenient and safer when your `params` are inside a [`Binder`].
///
/// [Obligation]: traits::Obligation
/// [`evaluate_obligation`]: crate::traits::query::evaluate_obligation::InferCtxtExt::evaluate_obligation
/// [`predicate_must_hold_modulo_regions`]: crate::traits::query::evaluate_obligation::InferCtxtExt::predicate_must_hold_modulo_regions
/// [`Binder`]: ty::Binder
#[instrument(level = "debug", skip(self, params), ret)] #[instrument(level = "debug", skip(self, params), ret)]
fn type_implements_trait( fn type_implements_trait(
&self, &self,