mirror of
https://github.com/sunface/rust-by-practice.git
synced 2025-06-23 12:39:42 +00:00
360 lines
16 KiB
HTML
360 lines
16 KiB
HTML
<!DOCTYPE HTML>
|
|
<html lang="en" class="light sidebar-visible" dir="ltr">
|
|
<head>
|
|
<!-- Book generated using mdBook -->
|
|
<meta charset="UTF-8">
|
|
<title>Const Generics - Rust By Practice</title>
|
|
|
|
|
|
<!-- Custom HTML head -->
|
|
|
|
<meta name="description" content="Learn Rust with Example, Exercise and real Practice, written with ❤️ by https://course.rs team">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
<meta name="theme-color" content="#ffffff">
|
|
|
|
<link rel="icon" href="../favicon.svg">
|
|
<link rel="shortcut icon" href="../favicon.png">
|
|
<link rel="stylesheet" href="../css/variables.css">
|
|
<link rel="stylesheet" href="../css/general.css">
|
|
<link rel="stylesheet" href="../css/chrome.css">
|
|
<link rel="stylesheet" href="../css/print.css" media="print">
|
|
|
|
<!-- Fonts -->
|
|
<link rel="stylesheet" href="../FontAwesome/css/font-awesome.css">
|
|
<link rel="stylesheet" href="../fonts/fonts.css">
|
|
|
|
<!-- Highlight.js Stylesheets -->
|
|
<link rel="stylesheet" id="highlight-css" href="../highlight.css">
|
|
<link rel="stylesheet" id="tomorrow-night-css" href="../tomorrow-night.css">
|
|
<link rel="stylesheet" id="ayu-highlight-css" href="../ayu-highlight.css">
|
|
|
|
<!-- Custom theme stylesheets -->
|
|
<link rel="stylesheet" href="../theme/style1.css">
|
|
|
|
|
|
<!-- Provide site root and default themes to javascript -->
|
|
<script>
|
|
const path_to_root = "../";
|
|
const default_light_theme = "light";
|
|
const default_dark_theme = "navy";
|
|
</script>
|
|
<!-- Start loading toc.js asap -->
|
|
<script src="../toc.js"></script>
|
|
</head>
|
|
<body>
|
|
<div id="body-container">
|
|
<!-- Work around some values being stored in localStorage wrapped in quotes -->
|
|
<script>
|
|
try {
|
|
let theme = localStorage.getItem('mdbook-theme');
|
|
let sidebar = localStorage.getItem('mdbook-sidebar');
|
|
|
|
if (theme.startsWith('"') && theme.endsWith('"')) {
|
|
localStorage.setItem('mdbook-theme', theme.slice(1, theme.length - 1));
|
|
}
|
|
|
|
if (sidebar.startsWith('"') && sidebar.endsWith('"')) {
|
|
localStorage.setItem('mdbook-sidebar', sidebar.slice(1, sidebar.length - 1));
|
|
}
|
|
} catch (e) { }
|
|
</script>
|
|
|
|
<!-- Set the theme before any content is loaded, prevents flash -->
|
|
<script>
|
|
const default_theme = window.matchMedia("(prefers-color-scheme: dark)").matches ? default_dark_theme : default_light_theme;
|
|
let theme;
|
|
try { theme = localStorage.getItem('mdbook-theme'); } catch(e) { }
|
|
if (theme === null || theme === undefined) { theme = default_theme; }
|
|
const html = document.documentElement;
|
|
html.classList.remove('light')
|
|
html.classList.add(theme);
|
|
html.classList.add("js");
|
|
</script>
|
|
|
|
<input type="checkbox" id="sidebar-toggle-anchor" class="hidden">
|
|
|
|
<!-- Hide / unhide sidebar before it is displayed -->
|
|
<script>
|
|
let sidebar = null;
|
|
const sidebar_toggle = document.getElementById("sidebar-toggle-anchor");
|
|
if (document.body.clientWidth >= 1080) {
|
|
try { sidebar = localStorage.getItem('mdbook-sidebar'); } catch(e) { }
|
|
sidebar = sidebar || 'visible';
|
|
} else {
|
|
sidebar = 'hidden';
|
|
}
|
|
sidebar_toggle.checked = sidebar === 'visible';
|
|
html.classList.remove('sidebar-visible');
|
|
html.classList.add("sidebar-" + sidebar);
|
|
</script>
|
|
|
|
<nav id="sidebar" class="sidebar" aria-label="Table of contents">
|
|
<!-- populated by js -->
|
|
<mdbook-sidebar-scrollbox class="sidebar-scrollbox"></mdbook-sidebar-scrollbox>
|
|
<noscript>
|
|
<iframe class="sidebar-iframe-outer" src="../toc.html"></iframe>
|
|
</noscript>
|
|
<div id="sidebar-resize-handle" class="sidebar-resize-handle">
|
|
<div class="sidebar-resize-indicator"></div>
|
|
</div>
|
|
</nav>
|
|
|
|
<div id="page-wrapper" class="page-wrapper">
|
|
|
|
<div class="page">
|
|
<div id="menu-bar-hover-placeholder"></div>
|
|
<div id="menu-bar" class="menu-bar sticky">
|
|
<div class="left-buttons">
|
|
<label id="sidebar-toggle" class="icon-button" for="sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="sidebar">
|
|
<i class="fa fa-bars"></i>
|
|
</label>
|
|
<button id="theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="theme-list">
|
|
<i class="fa fa-paint-brush"></i>
|
|
</button>
|
|
<ul id="theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
|
<li role="none"><button role="menuitem" class="theme" id="default_theme">Auto</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="light">Light</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="rust">Rust</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="coal">Coal</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="navy">Navy</button></li>
|
|
<li role="none"><button role="menuitem" class="theme" id="ayu">Ayu</button></li>
|
|
</ul>
|
|
<button id="search-toggle" class="icon-button" type="button" title="Search. (Shortkey: s)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="S" aria-controls="searchbar">
|
|
<i class="fa fa-search"></i>
|
|
</button>
|
|
</div>
|
|
|
|
<h1 class="menu-title">Rust By Practice</h1>
|
|
|
|
<div class="right-buttons">
|
|
<a href="../print.html" title="Print this book" aria-label="Print this book">
|
|
<i id="print-button" class="fa fa-print"></i>
|
|
</a>
|
|
<a href="https://github.com/sunface/rust-by-practice" title="Git repository" aria-label="Git repository">
|
|
<i id="git-repository-button" class="fa fa-github"></i>
|
|
</a>
|
|
<a href="https://github.com/sunface/rust-by-practice/edit/master/en/src/generics-traits/const-generics.md" title="Suggest an edit" aria-label="Suggest an edit">
|
|
<i id="git-edit-button" class="fa fa-edit"></i>
|
|
</a>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
<div id="search-wrapper" class="hidden">
|
|
<form id="searchbar-outer" class="searchbar-outer">
|
|
<input type="search" id="searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="searchresults-outer" aria-describedby="searchresults-header">
|
|
</form>
|
|
<div id="searchresults-outer" class="searchresults-outer hidden">
|
|
<div id="searchresults-header" class="searchresults-header"></div>
|
|
<ul id="searchresults">
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
|
<script>
|
|
document.getElementById('sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
|
document.getElementById('sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
|
Array.from(document.querySelectorAll('#sidebar a')).forEach(function(link) {
|
|
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
|
});
|
|
</script>
|
|
|
|
<div id="content" class="content">
|
|
<main>
|
|
<h1 id="const-generics"><a class="header" href="#const-generics">Const Generics</a></h1>
|
|
<p>Const generics are generic arguments that range over constant values, rather than types or lifetimes. This allows, for instance, types to be parameterized by integers. In fact, there has been one example of const generic types since early on in Rust's development: the array types [T; N], for some type T and N: usize. However, there has previously been no way to abstract over arrays of an arbitrary size: if you wanted to implement a trait for arrays of any size, you would have to do so manually for each possible value. For a long time, even the standard library methods for arrays were limited to arrays of length at most 32 due to this problem.</p>
|
|
<h2 id="examples"><a class="header" href="#examples">Examples</a></h2>
|
|
<ol>
|
|
<li>Here's an example of a type and implementation making use of const generics: a type wrapping a pair of arrays of the same size.</li>
|
|
</ol>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">struct ArrayPair<T, const N: usize> {
|
|
left: [T; N],
|
|
right: [T; N],
|
|
}
|
|
|
|
impl<T: Debug, const N: usize> Debug for ArrayPair<T, N> {
|
|
// ...
|
|
}</code></pre></pre>
|
|
<ol start="2">
|
|
<li>Currently, const parameters may only be instantiated by const arguments of the following forms:</li>
|
|
</ol>
|
|
<ul>
|
|
<li>A standalone const parameter.</li>
|
|
<li>A literal (i.e. an integer, bool, or character).</li>
|
|
<li>A concrete constant expression (enclosed by {}), involving no generic parameters.</li>
|
|
</ul>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">fn foo<const N: usize>() {}
|
|
|
|
fn bar<T, const M: usize>() {
|
|
foo::<M>(); // Okay: `M` is a const parameter
|
|
foo::<2021>(); // Okay: `2021` is a literal
|
|
foo::<{20 * 100 + 20 * 10 + 1}>(); // Okay: const expression contains no generic parameters
|
|
|
|
foo::<{ M + 1 }>(); // Error: const expression contains the generic parameter `M`
|
|
foo::<{ std::mem::size_of::<T>() }>(); // Error: const expression contains the generic parameter `T`
|
|
|
|
let _: [u8; M]; // Okay: `M` is a const parameter
|
|
let _: [u8; std::mem::size_of::<T>()]; // Error: const expression contains the generic parameter `T`
|
|
}
|
|
|
|
fn main() {}</code></pre></pre>
|
|
<ol start="3">
|
|
<li>Const generics can also let us avoid some runtime checks.</li>
|
|
</ol>
|
|
<pre><pre class="playground"><code class="language-rust edition2021">/// A region of memory containing at least `N` `T`s.
|
|
pub struct MinSlice<T, const N: usize> {
|
|
/// The bounded region of memory. Exactly `N` `T`s.
|
|
pub head: [T; N],
|
|
/// Zero or more remaining `T`s after the `N` in the bounded region.
|
|
pub tail: [T],
|
|
}
|
|
|
|
fn main() {
|
|
let slice: &[u8] = b"Hello, world";
|
|
let reference: Option<&u8> = slice.get(6);
|
|
// We know this value is `Some(b' ')`,
|
|
// but the compiler can't know that.
|
|
assert!(reference.is_some());
|
|
|
|
let slice: &[u8] = b"Hello, world";
|
|
// Length check is performed when we construct a MinSlice,
|
|
// and it's known at compile time to be of length 12.
|
|
// If the `unwrap()` succeeds, no more checks are needed
|
|
// throughout the `MinSlice`'s lifetime.
|
|
let minslice = MinSlice::<u8, 12>::from_slice(slice).unwrap();
|
|
let value: u8 = minslice.head[6];
|
|
assert_eq!(value, b' ')
|
|
}</code></pre></pre>
|
|
<h2 id="exercises"><a class="header" href="#exercises">Exercises</a></h2>
|
|
<ol>
|
|
<li>🌟🌟 <code><T, const N: usize></code> is part of the struct type, it means <code>Array<i32, 3></code> and <code>Array<i32, 4></code> are different types.</li>
|
|
</ol>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">struct Array<T, const N: usize> {
|
|
data : [T; N]
|
|
}
|
|
|
|
fn main() {
|
|
let arrays = [
|
|
Array{
|
|
data: [1, 2, 3],
|
|
},
|
|
Array {
|
|
data: [1.0, 2.0, 3.0],
|
|
},
|
|
Array {
|
|
data: [1, 2]
|
|
}
|
|
];
|
|
|
|
println!("Success!");
|
|
}</code></pre></pre>
|
|
<ol start="2">
|
|
<li>🌟🌟</li>
|
|
</ol>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">
|
|
// Fill in the blanks to make it work.
|
|
fn print_array<__>(__) {
|
|
println!("{:?}", arr);
|
|
}
|
|
fn main() {
|
|
let arr = [1, 2, 3];
|
|
print_array(arr);
|
|
|
|
let arr = ["hello", "world"];
|
|
print_array(arr);
|
|
}</code></pre></pre>
|
|
<ol start="3">
|
|
<li>🌟🌟🌟 Sometimes we want to limit the size of a variable, e.g when using in embedding environments, then <code>const expressions</code> will fit your needs.</li>
|
|
</ol>
|
|
<pre><pre class="playground"><code class="language-rust editable edition2021">#![allow(incomplete_features)]
|
|
#![feature(generic_const_exprs)]
|
|
|
|
fn check_size<T>(val: T)
|
|
where
|
|
Assert<{ core::mem::size_of::<T>() < 768 }>: IsTrue,
|
|
{
|
|
//...
|
|
}
|
|
|
|
// Fix the errors in main.
|
|
fn main() {
|
|
check_size([0u8; 767]);
|
|
check_size([0i32; 191]);
|
|
check_size(["hello你好"; __]); // Size of &str ?
|
|
check_size([(); __].map(|_| "hello你好".to_string())); // Size of String?
|
|
check_size(['中'; __]); // Size of char ?
|
|
|
|
println!("Success!");
|
|
}
|
|
|
|
|
|
|
|
pub enum Assert<const CHECK: bool> {}
|
|
|
|
pub trait IsTrue {}
|
|
|
|
impl IsTrue for Assert<true> {}</code></pre></pre>
|
|
<blockquote>
|
|
<p>You can find the solutions <a href="https://github.com/sunface/rust-by-practice/blob/master/solutions/generics-traits/const-generics.md">here</a>(under the solutions path), but only use it when you need it :)</p>
|
|
</blockquote>
|
|
|
|
</main>
|
|
|
|
<nav class="nav-wrapper" aria-label="Page navigation">
|
|
<!-- Mobile navigation buttons -->
|
|
<a rel="prev" href="../generics-traits/generics.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../generics-traits/traits.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
|
|
<div style="clear: both"></div>
|
|
</nav>
|
|
</div>
|
|
</div>
|
|
|
|
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
|
<a rel="prev" href="../generics-traits/generics.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
|
<i class="fa fa-angle-left"></i>
|
|
</a>
|
|
|
|
<a rel="next prefetch" href="../generics-traits/traits.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
|
<i class="fa fa-angle-right"></i>
|
|
</a>
|
|
</nav>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
|
|
<script>
|
|
window.playground_copyable = true;
|
|
</script>
|
|
|
|
<script src="../ace.js"></script>
|
|
<script src="../editor.js"></script>
|
|
<script src="../mode-rust.js"></script>
|
|
<script src="../theme-dawn.js"></script>
|
|
<script src="../theme-tomorrow_night.js"></script>
|
|
|
|
<script src="../elasticlunr.min.js"></script>
|
|
<script src="../mark.min.js"></script>
|
|
<script src="../searcher.js"></script>
|
|
|
|
<script src="../clipboard.min.js"></script>
|
|
<script src="../highlight.js"></script>
|
|
<script src="../book.js"></script>
|
|
|
|
<!-- Custom JS scripts -->
|
|
<script src="../assets/custom3.js"></script>
|
|
<script src="../assets/lang1.js"></script>
|
|
|
|
|
|
</div>
|
|
</body>
|
|
</html>
|