1 //! Module for inferring the variance of type and lifetime parameters. See the [rustc guide]
2 //! chapter for more info.
4 //! [rustc guide]: https://rust-lang.github.io/rustc-guide/variance.html
7 use rustc::ty::query::Providers;
8 use rustc::ty::{self, CrateVariancesMap, TyCtxt};
10 use rustc_hir::def_id::{CrateNum, DefId, LOCAL_CRATE};
12 /// Defines the `TermsContext` basically houses an arena where we can
16 /// Code to gather up constraints.
19 /// Code to solve constraints and write out the results.
22 /// Code to write unit tests of variance.
25 /// Code for transforming variances.
28 pub fn provide(providers: &mut Providers<'_>) {
29 *providers = Providers { variances_of, crate_variances, ..*providers };
32 fn crate_variances(tcx: TyCtxt<'_>, crate_num: CrateNum) -> &CrateVariancesMap<'_> {
33 assert_eq!(crate_num, LOCAL_CRATE);
34 let mut arena = arena::TypedArena::default();
35 let terms_cx = terms::determine_parameters_to_be_inferred(tcx, &mut arena);
36 let constraints_cx = constraints::add_constraints_from_crate(terms_cx);
37 tcx.arena.alloc(solve::solve_constraints(constraints_cx))
40 fn variances_of(tcx: TyCtxt<'_>, item_def_id: DefId) -> &[ty::Variance] {
41 let id = tcx.hir().as_local_hir_id(item_def_id).expect("expected local def-id");
42 let unsupported = || {
43 // Variance not relevant.
44 span_bug!(tcx.hir().span(id), "asked to compute variance for wrong kind of item")
46 match tcx.hir().get(id) {
47 Node::Item(item) => match item.kind {
48 hir::ItemKind::Enum(..)
49 | hir::ItemKind::Struct(..)
50 | hir::ItemKind::Union(..)
51 | hir::ItemKind::Fn(..) => {}
56 Node::TraitItem(item) => match item.kind {
57 hir::TraitItemKind::Method(..) => {}
62 Node::ImplItem(item) => match item.kind {
63 hir::ImplItemKind::Method(..) => {}
68 Node::ForeignItem(item) => match item.kind {
69 hir::ForeignItemKind::Fn(..) => {}
74 Node::Variant(_) | Node::Ctor(..) => {}
79 // Everything else must be inferred.
81 let crate_map = tcx.crate_variances(LOCAL_CRATE);
82 crate_map.variances.get(&item_def_id).copied().unwrap_or(&[])