bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Update documentation

Browse source
This commit is contained in:
Oli Scherer 2022-11-28 14:23:49 +00:00
parent 147b854ded
commit 46ba1545b8
3 changed files with 6 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

2
compiler/rustc_lint/src/pass_by_value.rs
View file

@ -10,7 +10,7 @@ declare_tool_lint! {
/// The `rustc_pass_by_value` lint marks a type with `#[rustc_pass_by_value]` requiring it to /// The `rustc_pass_by_value` lint marks a type with `#[rustc_pass_by_value]` requiring it to
/// always be passed by value. This is usually used for types that are thin wrappers around /// always be passed by value. This is usually used for types that are thin wrappers around
/// references, so there is no benefit to an extra layer of indirection. (Example: `Ty` which /// references, so there is no benefit to an extra layer of indirection. (Example: `Ty` which
/// is a reference to an `Interned<TyS>`) /// is a reference to an `Interned<TyKind>`)
pub rustc::PASS_BY_VALUE, pub rustc::PASS_BY_VALUE,
Warn, Warn,
"pass by reference of a type flagged as `#[rustc_pass_by_value]`", "pass by reference of a type flagged as `#[rustc_pass_by_value]`",

2
compiler/rustc_middle/src/mir/interpret/allocation.rs
View file

@ -103,7 +103,7 @@ impl hash::Hash for Allocation {
/// Interned types generally have an `Outer` type and an `Inner` type, where /// Interned types generally have an `Outer` type and an `Inner` type, where
/// `Outer` is a newtype around `Interned<Inner>`, and all the operations are /// `Outer` is a newtype around `Interned<Inner>`, and all the operations are
/// done on `Outer`, because all occurrences are interned. E.g. `Ty` is an /// done on `Outer`, because all occurrences are interned. E.g. `Ty` is an
/// outer type and `TyS` is its inner type. /// outer type and `TyKind` is its inner type.
/// ///
/// Here things are different because only const allocations are interned. This /// Here things are different because only const allocations are interned. This
/// means that both the inner type (`Allocation`) and the outer type /// means that both the inner type (`Allocation`) and the outer type

8
compiler/rustc_middle/src/ty/mod.rs
View file

@ -448,7 +448,7 @@ pub struct CReaderCacheKey {
pub pos: usize, pub pos: usize,
} }
/// Use this rather than `TyS`, whenever possible. /// Use this rather than `TyKind`, whenever possible.
#[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, HashStable)] #[derive(Copy, Clone, PartialEq, Eq, PartialOrd, Ord, Hash, HashStable)]
#[rustc_diagnostic_item = "Ty"] #[rustc_diagnostic_item = "Ty"]
#[rustc_pass_by_value] #[rustc_pass_by_value]
@ -476,13 +476,13 @@ impl ty::EarlyBoundRegion {
/// Represents a predicate. /// Represents a predicate.
/// ///
/// See comments on `TyS`, which apply here too (albeit for /// See comments on `WithCachedTypeInfo`, which apply here too (albeit for
/// `PredicateS`/`Predicate` rather than `TyS`/`Ty`). /// `PredicateS`/`Predicate` rather than `TyKind`/`Ty`).
#[derive(Debug)] #[derive(Debug)]
pub(crate) struct PredicateS<'tcx> { pub(crate) struct PredicateS<'tcx> {
kind: Binder<'tcx, PredicateKind<'tcx>>, kind: Binder<'tcx, PredicateKind<'tcx>>,
flags: TypeFlags, flags: TypeFlags,
/// See the comment for the corresponding field of [TyS]. /// See the comment for the corresponding field of [WithCachedTypeInfo].
outer_exclusive_binder: ty::DebruijnIndex, outer_exclusive_binder: ty::DebruijnIndex,
} }