nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2024-11-22 14:55:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Clarify docs explaining purpose of ConstArg

Browse Source 
Co-authored-by: Boxy <rust@boxyuwu.dev>
This commit is contained in:
Noah Lev 2024-07-17 20:07:50 -07:00
parent 37ed7a4438
commit 2e4a0e37e6
1 changed files with 6 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
compiler/rustc_hir/src/hir.rs
View File

@ -228,17 +228,16 @@ impl<'hir> PathSegment<'hir> {
}
}
/// A constant that enters the type system, e.g. through const generics or even
/// array lengths.
/// A constant that enters the type system, used for arguments to const generics (e.g. array lengths).
///
/// These are distinct from [`AnonConst`] in part because with the plan for
/// `min_generic_const_args`, arbitrary anonymous constants (like `Foo<{N + 1}>`)
/// will *not* be allowed to use generic parameters. Instead, it will be necessary
/// to add indirection using a free constant that itself has const parameters.
/// These are distinct from [`AnonConst`] as anon consts in the type system are not allowed
/// to use any generic parameters, therefore we must represent `N` differently. Additionally
/// future designs for supporting generic parameters in const arguments will likely not use
/// an anon const based design.
///
/// So, `ConstArg` (specifically, [`ConstArgKind`]) distinguishes between const args
/// that are [just paths](ConstArgKind::Path) (currently just bare const params)
/// versus const args that are literals or have arbitrary computations (e.g., `{ 1 + 3}`).
/// versus const args that are literals or have arbitrary computations (e.g., `{ 1 + 3 }`).
#[derive(Clone, Copy, Debug, HashStable_Generic)]
pub struct ConstArg<'hir> {
#[stable_hasher(ignore)]