build: 2026-06-22
This commit is contained in:
820
build/ch13-01-closures.html
Normal file
820
build/ch13-01-closures.html
Normal file
@@ -0,0 +1,820 @@
|
||||
<!DOCTYPE HTML>
|
||||
<html lang="en" class="light sidebar-visible" dir="ltr">
|
||||
<head>
|
||||
<!-- Book generated using mdBook -->
|
||||
<meta charset="UTF-8">
|
||||
<title>Closures - The Rust Programming Language</title>
|
||||
|
||||
|
||||
<!-- Custom HTML head -->
|
||||
|
||||
<meta name="description" content="">
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1">
|
||||
<meta name="theme-color" content="#ffffff">
|
||||
|
||||
<link rel="icon" href="favicon-de23e50b.svg">
|
||||
<link rel="shortcut icon" href="favicon-8114d1fc.png">
|
||||
<link rel="stylesheet" href="css/variables-8adf115d.css">
|
||||
<link rel="stylesheet" href="css/general-0392ca55.css">
|
||||
<link rel="stylesheet" href="css/chrome-fc474251.css">
|
||||
<link rel="stylesheet" href="css/print-9e4910d8.css" media="print">
|
||||
|
||||
<!-- Fonts -->
|
||||
<link rel="stylesheet" href="fonts/fonts-9644e21d.css">
|
||||
|
||||
<!-- Highlight.js Stylesheets -->
|
||||
<link rel="stylesheet" id="mdbook-highlight-css" href="highlight-493f70e1.css">
|
||||
<link rel="stylesheet" id="mdbook-tomorrow-night-css" href="tomorrow-night-4c0ae647.css">
|
||||
<link rel="stylesheet" id="mdbook-ayu-highlight-css" href="ayu-highlight-3fdfc3ac.css">
|
||||
|
||||
<!-- Custom theme stylesheets -->
|
||||
<link rel="stylesheet" href="ferris-d33b75bf.css">
|
||||
<link rel="stylesheet" href="theme/2018-edition-4e126c62.css">
|
||||
<link rel="stylesheet" href="theme/semantic-notes-9b5766c0.css">
|
||||
<link rel="stylesheet" href="theme/listing-cab26221.css">
|
||||
|
||||
|
||||
<!-- Provide site root and default themes to javascript -->
|
||||
<script>
|
||||
const path_to_root = "";
|
||||
const default_light_theme = "light";
|
||||
const default_dark_theme = "navy";
|
||||
window.path_to_searchindex_js = "searchindex-6a1da8cc.js";
|
||||
</script>
|
||||
<!-- Start loading toc.js asap -->
|
||||
<script src="toc-0e4ce700.js"></script>
|
||||
</head>
|
||||
<body>
|
||||
<div id="mdbook-help-container">
|
||||
<div id="mdbook-help-popup">
|
||||
<h2 class="mdbook-help-title">Keyboard shortcuts</h2>
|
||||
<div>
|
||||
<p>Press <kbd>←</kbd> or <kbd>→</kbd> to navigate between chapters</p>
|
||||
<p>Press <kbd>S</kbd> or <kbd>/</kbd> to search in the book</p>
|
||||
<p>Press <kbd>?</kbd> to show this help</p>
|
||||
<p>Press <kbd>Esc</kbd> to hide this help</p>
|
||||
</div>
|
||||
</div>
|
||||
</div>
|
||||
<div id="mdbook-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="mdbook-sidebar-toggle-anchor" class="hidden">
|
||||
|
||||
<!-- Hide / unhide sidebar before it is displayed -->
|
||||
<script>
|
||||
let sidebar = null;
|
||||
const sidebar_toggle = document.getElementById("mdbook-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 = false;
|
||||
}
|
||||
if (sidebar === 'visible') {
|
||||
sidebar_toggle.checked = true;
|
||||
} else {
|
||||
html.classList.remove('sidebar-visible');
|
||||
}
|
||||
</script>
|
||||
|
||||
<nav id="mdbook-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="mdbook-sidebar-resize-handle" class="sidebar-resize-handle">
|
||||
<div class="sidebar-resize-indicator"></div>
|
||||
</div>
|
||||
</nav>
|
||||
|
||||
<div id="mdbook-page-wrapper" class="page-wrapper">
|
||||
|
||||
<div class="page">
|
||||
<div id="mdbook-menu-bar-hover-placeholder"></div>
|
||||
<div id="mdbook-menu-bar" class="menu-bar sticky">
|
||||
<div class="left-buttons">
|
||||
<label id="mdbook-sidebar-toggle" class="icon-button" for="mdbook-sidebar-toggle-anchor" title="Toggle Table of Contents" aria-label="Toggle Table of Contents" aria-controls="mdbook-sidebar">
|
||||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M0 96C0 78.3 14.3 64 32 64H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32C14.3 128 0 113.7 0 96zM0 256c0-17.7 14.3-32 32-32H416c17.7 0 32 14.3 32 32s-14.3 32-32 32H32c-17.7 0-32-14.3-32-32zM448 416c0 17.7-14.3 32-32 32H32c-17.7 0-32-14.3-32-32s14.3-32 32-32H416c17.7 0 32 14.3 32 32z"/></svg></span>
|
||||
</label>
|
||||
<button id="mdbook-theme-toggle" class="icon-button" type="button" title="Change theme" aria-label="Change theme" aria-haspopup="true" aria-expanded="false" aria-controls="mdbook-theme-list">
|
||||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M371.3 367.1c27.3-3.9 51.9-19.4 67.2-42.9L600.2 74.1c12.6-19.5 9.4-45.3-7.6-61.2S549.7-4.4 531.1 9.6L294.4 187.2c-24 18-38.2 46.1-38.4 76.1L371.3 367.1zm-19.6 25.4l-116-104.4C175.9 290.3 128 339.6 128 400c0 3.9 .2 7.8 .6 11.6c1.8 17.5-10.2 36.4-27.8 36.4H96c-17.7 0-32 14.3-32 32s14.3 32 32 32H240c61.9 0 112-50.1 112-112c0-2.5-.1-5-.2-7.5z"/></svg></span>
|
||||
</button>
|
||||
<ul id="mdbook-theme-list" class="theme-popup" aria-label="Themes" role="menu">
|
||||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-default_theme">Auto</button></li>
|
||||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-light">Light</button></li>
|
||||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-rust">Rust</button></li>
|
||||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-coal">Coal</button></li>
|
||||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-navy">Navy</button></li>
|
||||
<li role="none"><button role="menuitem" class="theme" id="mdbook-theme-ayu">Ayu</button></li>
|
||||
</ul>
|
||||
<button id="mdbook-search-toggle" class="icon-button" type="button" title="Search (`/`)" aria-label="Toggle Searchbar" aria-expanded="false" aria-keyshortcuts="/ s" aria-controls="mdbook-searchbar">
|
||||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M416 208c0 45.9-14.9 88.3-40 122.7L502.6 457.4c12.5 12.5 12.5 32.8 0 45.3s-32.8 12.5-45.3 0L330.7 376c-34.4 25.2-76.8 40-122.7 40C93.1 416 0 322.9 0 208S93.1 0 208 0S416 93.1 416 208zM208 352c79.5 0 144-64.5 144-144s-64.5-144-144-144S64 128.5 64 208s64.5 144 144 144z"/></svg></span>
|
||||
</button>
|
||||
</div>
|
||||
|
||||
<h1 class="menu-title">The Rust Programming Language</h1>
|
||||
|
||||
<div class="right-buttons">
|
||||
<a href="print.html" title="Print this book" aria-label="Print this book">
|
||||
<span class=fa-svg id="print-button"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M128 0C92.7 0 64 28.7 64 64v96h64V64H354.7L384 93.3V160h64V93.3c0-17-6.7-33.3-18.7-45.3L400 18.7C388 6.7 371.7 0 354.7 0H128zM384 352v32 64H128V384 368 352H384zm64 32h32c17.7 0 32-14.3 32-32V256c0-35.3-28.7-64-64-64H64c-35.3 0-64 28.7-64 64v96c0 17.7 14.3 32 32 32H64v64c0 35.3 28.7 64 64 64H384c35.3 0 64-28.7 64-64V384zm-16-88c-13.3 0-24-10.7-24-24s10.7-24 24-24s24 10.7 24 24s-10.7 24-24 24z"/></svg></span>
|
||||
</a>
|
||||
<a href="https://github.com/rust-lang/book" title="Git repository" aria-label="Git repository">
|
||||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6zm-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3zm44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9zM244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1zm-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7zm32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg></span>
|
||||
</a>
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div id="mdbook-search-wrapper" class="hidden">
|
||||
<form id="mdbook-searchbar-outer" class="searchbar-outer">
|
||||
<div class="search-wrapper">
|
||||
<input type="search" id="mdbook-searchbar" name="searchbar" placeholder="Search this book ..." aria-controls="mdbook-searchresults-outer" aria-describedby="searchresults-header">
|
||||
<div class="spinner-wrapper">
|
||||
<span class=fa-svg id="fa-spin"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M304 48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zm0 416c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM48 304c26.5 0 48-21.5 48-48s-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48zm464-48c0-26.5-21.5-48-48-48s-48 21.5-48 48s21.5 48 48 48s48-21.5 48-48zM142.9 437c18.7-18.7 18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zm0-294.2c18.7-18.7 18.7-49.1 0-67.9S93.7 56.2 75 75s-18.7 49.1 0 67.9s49.1 18.7 67.9 0zM369.1 437c18.7 18.7 49.1 18.7 67.9 0s18.7-49.1 0-67.9s-49.1-18.7-67.9 0s-18.7 49.1 0 67.9z"/></svg></span>
|
||||
</div>
|
||||
</div>
|
||||
</form>
|
||||
<div id="mdbook-searchresults-outer" class="searchresults-outer hidden">
|
||||
<div id="mdbook-searchresults-header" class="searchresults-header"></div>
|
||||
<ul id="mdbook-searchresults">
|
||||
</ul>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<!-- Apply ARIA attributes after the sidebar and the sidebar toggle button are added to the DOM -->
|
||||
<script>
|
||||
document.getElementById('mdbook-sidebar-toggle').setAttribute('aria-expanded', sidebar === 'visible');
|
||||
document.getElementById('mdbook-sidebar').setAttribute('aria-hidden', sidebar !== 'visible');
|
||||
Array.from(document.querySelectorAll('#mdbook-sidebar a')).forEach(function(link) {
|
||||
link.setAttribute('tabIndex', sidebar === 'visible' ? 0 : -1);
|
||||
});
|
||||
</script>
|
||||
|
||||
<div id="mdbook-content" class="content">
|
||||
<main>
|
||||
<!-- Old headings. Do not remove or links may break. -->
|
||||
<p><a id="closures-anonymous-functions-that-can-capture-their-environment"></a>
|
||||
<a id="closures-anonymous-functions-that-capture-their-environment"></a></p>
|
||||
<h2 id="closures"><a class="header" href="#closures">Closures</a></h2>
|
||||
<p>Rust’s closures are anonymous functions you can save in a variable or pass as
|
||||
arguments to other functions. You can create the closure in one place and then
|
||||
call the closure elsewhere to evaluate it in a different context. Unlike
|
||||
functions, closures can capture values from the scope in which they’re defined.
|
||||
We’ll demonstrate how these closure features allow for code reuse and behavior
|
||||
customization.</p>
|
||||
<!-- Old headings. Do not remove or links may break. -->
|
||||
<p><a id="creating-an-abstraction-of-behavior-with-closures"></a>
|
||||
<a id="refactoring-using-functions"></a>
|
||||
<a id="refactoring-with-closures-to-store-code"></a>
|
||||
<a id="capturing-the-environment-with-closures"></a></p>
|
||||
<h3 id="capturing-the-environment"><a class="header" href="#capturing-the-environment">Capturing the Environment</a></h3>
|
||||
<p>We’ll first examine how we can use closures to capture values from the
|
||||
environment they’re defined in for later use. Here’s the scenario: Every so
|
||||
often, our T-shirt company gives away an exclusive, limited-edition shirt to
|
||||
someone on our mailing list as a promotion. People on the mailing list can
|
||||
optionally add their favorite color to their profile. If the person chosen for
|
||||
a free shirt has their favorite color set, they get that color shirt. If the
|
||||
person hasn’t specified a favorite color, they get whatever color the company
|
||||
currently has the most of.</p>
|
||||
<p>There are many ways to implement this. For this example, we’re going to use an
|
||||
enum called <code>ShirtColor</code> that has the variants <code>Red</code> and <code>Blue</code> (limiting the
|
||||
number of colors available for simplicity). We represent the company’s
|
||||
inventory with an <code>Inventory</code> struct that has a field named <code>shirts</code> that
|
||||
contains a <code>Vec<ShirtColor></code> representing the shirt colors currently in stock.
|
||||
The method <code>giveaway</code> defined on <code>Inventory</code> gets the optional shirt color
|
||||
preference of the free-shirt winner, and it returns the shirt color the
|
||||
person will get. This setup is shown in Listing 13-1.</p>
|
||||
<figure class="listing" id="listing-13-1">
|
||||
<span class="file-name">Filename: src/main.rs</span>
|
||||
<pre><code class="language-rust noplayground">#[derive(Debug, PartialEq, Copy, Clone)]
|
||||
enum ShirtColor {
|
||||
Red,
|
||||
Blue,
|
||||
}
|
||||
|
||||
struct Inventory {
|
||||
shirts: Vec<ShirtColor>,
|
||||
}
|
||||
|
||||
impl Inventory {
|
||||
fn giveaway(&self, user_preference: Option<ShirtColor>) -> ShirtColor {
|
||||
user_preference.unwrap_or_else(|| self.most_stocked())
|
||||
}
|
||||
|
||||
fn most_stocked(&self) -> ShirtColor {
|
||||
let mut num_red = 0;
|
||||
let mut num_blue = 0;
|
||||
|
||||
for color in &self.shirts {
|
||||
match color {
|
||||
ShirtColor::Red => num_red += 1,
|
||||
ShirtColor::Blue => num_blue += 1,
|
||||
}
|
||||
}
|
||||
if num_red > num_blue {
|
||||
ShirtColor::Red
|
||||
} else {
|
||||
ShirtColor::Blue
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let store = Inventory {
|
||||
shirts: vec![ShirtColor::Blue, ShirtColor::Red, ShirtColor::Blue],
|
||||
};
|
||||
|
||||
let user_pref1 = Some(ShirtColor::Red);
|
||||
let giveaway1 = store.giveaway(user_pref1);
|
||||
println!(
|
||||
"The user with preference {:?} gets {:?}",
|
||||
user_pref1, giveaway1
|
||||
);
|
||||
|
||||
let user_pref2 = None;
|
||||
let giveaway2 = store.giveaway(user_pref2);
|
||||
println!(
|
||||
"The user with preference {:?} gets {:?}",
|
||||
user_pref2, giveaway2
|
||||
);
|
||||
}</code></pre>
|
||||
<figcaption><a href="#listing-13-1">Listing 13-1</a>: Shirt company giveaway situation</figcaption>
|
||||
</figure>
|
||||
<p>The <code>store</code> defined in <code>main</code> has two blue shirts and one red shirt remaining
|
||||
to distribute for this limited-edition promotion. We call the <code>giveaway</code> method
|
||||
for a user with a preference for a red shirt and a user without any preference.</p>
|
||||
<p>Again, this code could be implemented in many ways, and here, to focus on
|
||||
closures, we’ve stuck to concepts you’ve already learned, except for the body of
|
||||
the <code>giveaway</code> method that uses a closure. In the <code>giveaway</code> method, we get the
|
||||
user preference as a parameter of type <code>Option<ShirtColor></code> and call the
|
||||
<code>unwrap_or_else</code> method on <code>user_preference</code>. The <a href="../std/option/enum.Option.html#method.unwrap_or_else"><code>unwrap_or_else</code> method on
|
||||
<code>Option<T></code></a><!-- ignore --> is defined by the standard library.
|
||||
It takes one argument: a closure without any arguments that returns a value <code>T</code>
|
||||
(the same type stored in the <code>Some</code> variant of the <code>Option<T></code>, in this case
|
||||
<code>ShirtColor</code>). If the <code>Option<T></code> is the <code>Some</code> variant, <code>unwrap_or_else</code>
|
||||
returns the value from within the <code>Some</code>. If the <code>Option<T></code> is the <code>None</code>
|
||||
variant, <code>unwrap_or_else</code> calls the closure and returns the value returned by
|
||||
the closure.</p>
|
||||
<p>We specify the closure expression <code>|| self.most_stocked()</code> as the argument to
|
||||
<code>unwrap_or_else</code>. This is a closure that takes no parameters itself (if the
|
||||
closure had parameters, they would appear between the two vertical pipes). The
|
||||
body of the closure calls <code>self.most_stocked()</code>. We’re defining the closure
|
||||
here, and the implementation of <code>unwrap_or_else</code> will evaluate the closure
|
||||
later if the result is needed.</p>
|
||||
<p>Running this code prints the following:</p>
|
||||
<pre><code class="language-console">$ cargo run
|
||||
Compiling shirt-company v0.1.0 (file:///projects/shirt-company)
|
||||
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.27s
|
||||
Running `target/debug/shirt-company`
|
||||
The user with preference Some(Red) gets Red
|
||||
The user with preference None gets Blue
|
||||
</code></pre>
|
||||
<p>One interesting aspect here is that we’ve passed a closure that calls
|
||||
<code>self.most_stocked()</code> on the current <code>Inventory</code> instance. The standard library
|
||||
didn’t need to know anything about the <code>Inventory</code> or <code>ShirtColor</code> types we
|
||||
defined, or the logic we want to use in this scenario. The closure captures an
|
||||
immutable reference to the <code>self</code> <code>Inventory</code> instance and passes it with the
|
||||
code we specify to the <code>unwrap_or_else</code> method. Functions, on the other hand,
|
||||
are not able to capture their environment in this way.</p>
|
||||
<!-- Old headings. Do not remove or links may break. -->
|
||||
<p><a id="closure-type-inference-and-annotation"></a></p>
|
||||
<h3 id="inferring-and-annotating-closure-types"><a class="header" href="#inferring-and-annotating-closure-types">Inferring and Annotating Closure Types</a></h3>
|
||||
<p>There are more differences between functions and closures. Closures don’t
|
||||
usually require you to annotate the types of the parameters or the return value
|
||||
like <code>fn</code> functions do. Type annotations are required on functions because the
|
||||
types are part of an explicit interface exposed to your users. Defining this
|
||||
interface rigidly is important for ensuring that everyone agrees on what types
|
||||
of values a function uses and returns. Closures, on the other hand, aren’t used
|
||||
in an exposed interface like this: They’re stored in variables, and they’re
|
||||
used without naming them and exposing them to users of our library.</p>
|
||||
<p>Closures are typically short and relevant only within a narrow context rather
|
||||
than in any arbitrary scenario. Within these limited contexts, the compiler can
|
||||
infer the types of the parameters and the return type, similar to how it’s able
|
||||
to infer the types of most variables (there are rare cases where the compiler
|
||||
needs closure type annotations too).</p>
|
||||
<p>As with variables, we can add type annotations if we want to increase
|
||||
explicitness and clarity at the cost of being more verbose than is strictly
|
||||
necessary. Annotating the types for a closure would look like the definition
|
||||
shown in Listing 13-2. In this example, we’re defining a closure and storing it
|
||||
in a variable rather than defining the closure in the spot we pass it as an
|
||||
argument, as we did in Listing 13-1.</p>
|
||||
<figure class="listing" id="listing-13-2">
|
||||
<span class="file-name">Filename: src/main.rs</span>
|
||||
<pre class="playground"><code class="language-rust edition2024"><span class="boring">use std::thread;
|
||||
</span><span class="boring">use std::time::Duration;
|
||||
</span><span class="boring">
|
||||
</span><span class="boring">fn generate_workout(intensity: u32, random_number: u32) {
|
||||
</span> let expensive_closure = |num: u32| -> u32 {
|
||||
println!("calculating slowly...");
|
||||
thread::sleep(Duration::from_secs(2));
|
||||
num
|
||||
};
|
||||
<span class="boring">
|
||||
</span><span class="boring"> if intensity < 25 {
|
||||
</span><span class="boring"> println!("Today, do {} pushups!", expensive_closure(intensity));
|
||||
</span><span class="boring"> println!("Next, do {} situps!", expensive_closure(intensity));
|
||||
</span><span class="boring"> } else {
|
||||
</span><span class="boring"> if random_number == 3 {
|
||||
</span><span class="boring"> println!("Take a break today! Remember to stay hydrated!");
|
||||
</span><span class="boring"> } else {
|
||||
</span><span class="boring"> println!(
|
||||
</span><span class="boring"> "Today, run for {} minutes!",
|
||||
</span><span class="boring"> expensive_closure(intensity)
|
||||
</span><span class="boring"> );
|
||||
</span><span class="boring"> }
|
||||
</span><span class="boring"> }
|
||||
</span><span class="boring">}
|
||||
</span><span class="boring">
|
||||
</span><span class="boring">fn main() {
|
||||
</span><span class="boring"> let simulated_user_specified_value = 10;
|
||||
</span><span class="boring"> let simulated_random_number = 7;
|
||||
</span><span class="boring">
|
||||
</span><span class="boring"> generate_workout(simulated_user_specified_value, simulated_random_number);
|
||||
</span><span class="boring">}</span></code></pre>
|
||||
<figcaption><a href="#listing-13-2">Listing 13-2</a>: Adding optional type annotations of the parameter and return value types in the closure</figcaption>
|
||||
</figure>
|
||||
<p>With type annotations added, the syntax of closures looks more similar to the
|
||||
syntax of functions. Here, we define a function that adds 1 to its parameter and
|
||||
a closure that has the same behavior, for comparison. We’ve added some spaces
|
||||
to line up the relevant parts. This illustrates how closure syntax is similar
|
||||
to function syntax except for the use of pipes and the amount of syntax that is
|
||||
optional:</p>
|
||||
<pre><code class="language-rust ignore">fn add_one_v1 (x: u32) -> u32 { x + 1 }
|
||||
let add_one_v2 = |x: u32| -> u32 { x + 1 };
|
||||
let add_one_v3 = |x| { x + 1 };
|
||||
let add_one_v4 = |x| x + 1 ;</code></pre>
|
||||
<p>The first line shows a function definition and the second line shows a fully
|
||||
annotated closure definition. In the third line, we remove the type annotations
|
||||
from the closure definition. In the fourth line, we remove the brackets, which
|
||||
are optional because the closure body has only one expression. These are all
|
||||
valid definitions that will produce the same behavior when they’re called. The
|
||||
<code>add_one_v3</code> and <code>add_one_v4</code> lines require the closures to be evaluated to be
|
||||
able to compile because the types will be inferred from their usage. This is
|
||||
similar to <code>let v = Vec::new();</code> needing either type annotations or values of
|
||||
some type to be inserted into the <code>Vec</code> for Rust to be able to infer the type.</p>
|
||||
<p>For closure definitions, the compiler will infer one concrete type for each of
|
||||
their parameters and for their return value. For instance, Listing 13-3 shows
|
||||
the definition of a short closure that just returns the value it receives as a
|
||||
parameter. This closure isn’t very useful except for the purposes of this
|
||||
example. Note that we haven’t added any type annotations to the definition.
|
||||
Because there are no type annotations, we can call the closure with any type,
|
||||
which we’ve done here with <code>String</code> the first time. If we then try to call
|
||||
<code>example_closure</code> with an integer, we’ll get an error.</p>
|
||||
<figure class="listing" id="listing-13-3">
|
||||
<span class="file-name">Filename: src/main.rs</span>
|
||||
<pre><code class="language-rust ignore does_not_compile"><span class="boring">fn main() {
|
||||
</span> let example_closure = |x| x;
|
||||
|
||||
let s = example_closure(String::from("hello"));
|
||||
let n = example_closure(5);
|
||||
<span class="boring">}</span></code></pre>
|
||||
<figcaption><a href="#listing-13-3">Listing 13-3</a>: Attempting to call a closure whose types are inferred with two different types</figcaption>
|
||||
</figure>
|
||||
<p>The compiler gives us this error:</p>
|
||||
<pre><code class="language-console">$ cargo run
|
||||
Compiling closure-example v0.1.0 (file:///projects/closure-example)
|
||||
error[E0308]: mismatched types
|
||||
--> src/main.rs:5:29
|
||||
|
|
||||
5 | let n = example_closure(5);
|
||||
| --------------- ^ expected `String`, found integer
|
||||
| |
|
||||
| arguments to this function are incorrect
|
||||
|
|
||||
note: expected because the closure was earlier called with an argument of type `String`
|
||||
--> src/main.rs:4:29
|
||||
|
|
||||
4 | let s = example_closure(String::from("hello"));
|
||||
| --------------- ^^^^^^^^^^^^^^^^^^^^^ expected because this argument is of type `String`
|
||||
| |
|
||||
| in this closure call
|
||||
note: closure parameter defined here
|
||||
--> src/main.rs:2:28
|
||||
|
|
||||
2 | let example_closure = |x| x;
|
||||
| ^
|
||||
help: try using a conversion method
|
||||
|
|
||||
5 | let n = example_closure(5.to_string());
|
||||
| ++++++++++++
|
||||
|
||||
For more information about this error, try `rustc --explain E0308`.
|
||||
error: could not compile `closure-example` (bin "closure-example") due to 1 previous error
|
||||
</code></pre>
|
||||
<p>The first time we call <code>example_closure</code> with the <code>String</code> value, the compiler
|
||||
infers the type of <code>x</code> and the return type of the closure to be <code>String</code>. Those
|
||||
types are then locked into the closure in <code>example_closure</code>, and we get a type
|
||||
error when we next try to use a different type with the same closure.</p>
|
||||
<h3 id="capturing-references-or-moving-ownership"><a class="header" href="#capturing-references-or-moving-ownership">Capturing References or Moving Ownership</a></h3>
|
||||
<p>Closures can capture values from their environment in three ways, which
|
||||
directly map to the three ways a function can take a parameter: borrowing
|
||||
immutably, borrowing mutably, and taking ownership. The closure will decide
|
||||
which of these to use based on what the body of the function does with the
|
||||
captured values.</p>
|
||||
<p>In Listing 13-4, we define a closure that captures an immutable reference to
|
||||
the vector named <code>list</code> because it only needs an immutable reference to print
|
||||
the value.</p>
|
||||
<figure class="listing" id="listing-13-4">
|
||||
<span class="file-name">Filename: src/main.rs</span>
|
||||
<pre class="playground"><code class="language-rust edition2024">fn main() {
|
||||
let list = vec![1, 2, 3];
|
||||
println!("Before defining closure: {list:?}");
|
||||
|
||||
let only_borrows = || println!("From closure: {list:?}");
|
||||
|
||||
println!("Before calling closure: {list:?}");
|
||||
only_borrows();
|
||||
println!("After calling closure: {list:?}");
|
||||
}</code></pre>
|
||||
<figcaption><a href="#listing-13-4">Listing 13-4</a>: Defining and calling a closure that captures an immutable reference</figcaption>
|
||||
</figure>
|
||||
<p>This example also illustrates that a variable can bind to a closure definition,
|
||||
and we can later call the closure by using the variable name and parentheses as
|
||||
if the variable name were a function name.</p>
|
||||
<p>Because we can have multiple immutable references to <code>list</code> at the same time,
|
||||
<code>list</code> is still accessible from the code before the closure definition, after
|
||||
the closure definition but before the closure is called, and after the closure
|
||||
is called. This code compiles, runs, and prints:</p>
|
||||
<pre><code class="language-console">$ cargo run
|
||||
Compiling closure-example v0.1.0 (file:///projects/closure-example)
|
||||
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.43s
|
||||
Running `target/debug/closure-example`
|
||||
Before defining closure: [1, 2, 3]
|
||||
Before calling closure: [1, 2, 3]
|
||||
From closure: [1, 2, 3]
|
||||
After calling closure: [1, 2, 3]
|
||||
</code></pre>
|
||||
<p>Next, in Listing 13-5, we change the closure body so that it adds an element to
|
||||
the <code>list</code> vector. The closure now captures a mutable reference.</p>
|
||||
<figure class="listing" id="listing-13-5">
|
||||
<span class="file-name">Filename: src/main.rs</span>
|
||||
<pre class="playground"><code class="language-rust edition2024">fn main() {
|
||||
let mut list = vec![1, 2, 3];
|
||||
println!("Before defining closure: {list:?}");
|
||||
|
||||
let mut borrows_mutably = || list.push(7);
|
||||
|
||||
borrows_mutably();
|
||||
println!("After calling closure: {list:?}");
|
||||
}</code></pre>
|
||||
<figcaption><a href="#listing-13-5">Listing 13-5</a>: Defining and calling a closure that captures a mutable reference</figcaption>
|
||||
</figure>
|
||||
<p>This code compiles, runs, and prints:</p>
|
||||
<pre><code class="language-console">$ cargo run
|
||||
Compiling closure-example v0.1.0 (file:///projects/closure-example)
|
||||
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.43s
|
||||
Running `target/debug/closure-example`
|
||||
Before defining closure: [1, 2, 3]
|
||||
After calling closure: [1, 2, 3, 7]
|
||||
</code></pre>
|
||||
<p>Note that there’s no longer a <code>println!</code> between the definition and the call of
|
||||
the <code>borrows_mutably</code> closure: When <code>borrows_mutably</code> is defined, it captures a
|
||||
mutable reference to <code>list</code>. We don’t use the closure again after the closure
|
||||
is called, so the mutable borrow ends. Between the closure definition and the
|
||||
closure call, an immutable borrow to print isn’t allowed, because no other
|
||||
borrows are allowed when there’s a mutable borrow. Try adding a <code>println!</code>
|
||||
there to see what error message you get!</p>
|
||||
<p>If you want to force the closure to take ownership of the values it uses in the
|
||||
environment even though the body of the closure doesn’t strictly need
|
||||
ownership, you can use the <code>move</code> keyword before the parameter list.</p>
|
||||
<p>This technique is mostly useful when passing a closure to a new thread to move
|
||||
the data so that it’s owned by the new thread. We’ll discuss threads and why
|
||||
you would want to use them in detail in Chapter 16 when we talk about
|
||||
concurrency, but for now, let’s briefly explore spawning a new thread using a
|
||||
closure that needs the <code>move</code> keyword. Listing 13-6 shows Listing 13-4 modified
|
||||
to print the vector in a new thread rather than in the main thread.</p>
|
||||
<figure class="listing" id="listing-13-6">
|
||||
<span class="file-name">Filename: src/main.rs</span>
|
||||
<pre class="playground"><code class="language-rust edition2024">use std::thread;
|
||||
|
||||
fn main() {
|
||||
let list = vec![1, 2, 3];
|
||||
println!("Before defining closure: {list:?}");
|
||||
|
||||
thread::spawn(move || println!("From thread: {list:?}"))
|
||||
.join()
|
||||
.unwrap();
|
||||
}</code></pre>
|
||||
<figcaption><a href="#listing-13-6">Listing 13-6</a>: Using <code>move</code> to force the closure for the thread to take ownership of <code>list</code></figcaption>
|
||||
</figure>
|
||||
<p>We spawn a new thread, giving the thread a closure to run as an argument. The
|
||||
closure body prints out the list. In Listing 13-4, the closure only captured
|
||||
<code>list</code> using an immutable reference because that’s the least amount of access
|
||||
to <code>list</code> needed to print it. In this example, even though the closure body
|
||||
still only needs an immutable reference, we need to specify that <code>list</code> should
|
||||
be moved into the closure by putting the <code>move</code> keyword at the beginning of the
|
||||
closure definition. If the main thread performed more operations before calling
|
||||
<code>join</code> on the new thread, the new thread might finish before the rest of the
|
||||
main thread finishes, or the main thread might finish first. If the main thread
|
||||
maintained ownership of <code>list</code> but ended before the new thread and drops
|
||||
<code>list</code>, the immutable reference in the thread would be invalid. Therefore, the
|
||||
compiler requires that <code>list</code> be moved into the closure given to the new thread
|
||||
so that the reference will be valid. Try removing the <code>move</code> keyword or using
|
||||
<code>list</code> in the main thread after the closure is defined to see what compiler
|
||||
errors you get!</p>
|
||||
<!-- Old headings. Do not remove or links may break. -->
|
||||
<p><a id="storing-closures-using-generic-parameters-and-the-fn-traits"></a>
|
||||
<a id="limitations-of-the-cacher-implementation"></a>
|
||||
<a id="moving-captured-values-out-of-the-closure-and-the-fn-traits"></a>
|
||||
<a id="moving-captured-values-out-of-closures-and-the-fn-traits"></a></p>
|
||||
<h3 id="moving-captured-values-out-of-closures"><a class="header" href="#moving-captured-values-out-of-closures">Moving Captured Values Out of Closures</a></h3>
|
||||
<p>Once a closure has captured a reference or captured ownership of a value from
|
||||
the environment where the closure is defined (thus affecting what, if anything,
|
||||
is moved <em>into</em> the closure), the code in the body of the closure defines what
|
||||
happens to the references or values when the closure is evaluated later (thus
|
||||
affecting what, if anything, is moved <em>out of</em> the closure).</p>
|
||||
<p>A closure body can do any of the following: Move a captured value out of the
|
||||
closure, mutate the captured value, neither move nor mutate the value, or
|
||||
capture nothing from the environment to begin with.</p>
|
||||
<p>The way a closure captures and handles values from the environment affects
|
||||
which traits the closure implements, and traits are how functions and structs
|
||||
can specify what kinds of closures they can use. Closures will automatically
|
||||
implement one, two, or all three of these <code>Fn</code> traits, in an additive fashion,
|
||||
depending on how the closure’s body handles the values:</p>
|
||||
<ul>
|
||||
<li><code>FnOnce</code> applies to closures that can be called once. All closures implement
|
||||
at least this trait because all closures can be called. A closure that moves
|
||||
captured values out of its body will only implement <code>FnOnce</code> and none of the
|
||||
other <code>Fn</code> traits because it can only be called once.</li>
|
||||
<li><code>FnMut</code> applies to closures that don’t move captured values out of their body
|
||||
but might mutate the captured values. These closures can be called more than
|
||||
once.</li>
|
||||
<li><code>Fn</code> applies to closures that don’t move captured values out of their body
|
||||
and don’t mutate captured values, as well as closures that capture nothing
|
||||
from their environment. These closures can be called more than once without
|
||||
mutating their environment, which is important in cases such as calling a closure multiple times concurrently.</li>
|
||||
</ul>
|
||||
<p>Let’s look at the definition of the <code>unwrap_or_else</code> method on <code>Option<T></code> that
|
||||
we used in Listing 13-1:</p>
|
||||
<pre><code class="language-rust ignore">impl<T> Option<T> {
|
||||
pub fn unwrap_or_else<F>(self, f: F) -> T
|
||||
where
|
||||
F: FnOnce() -> T
|
||||
{
|
||||
match self {
|
||||
Some(x) => x,
|
||||
None => f(),
|
||||
}
|
||||
}
|
||||
}</code></pre>
|
||||
<p>Recall that <code>T</code> is the generic type representing the type of the value in the
|
||||
<code>Some</code> variant of an <code>Option</code>. That type <code>T</code> is also the return type of the
|
||||
<code>unwrap_or_else</code> function: Code that calls <code>unwrap_or_else</code> on an
|
||||
<code>Option<String></code>, for example, will get a <code>String</code>.</p>
|
||||
<p>Next, notice that the <code>unwrap_or_else</code> function has the additional generic type
|
||||
parameter <code>F</code>. The <code>F</code> type is the type of the parameter named <code>f</code>, which is
|
||||
the closure we provide when calling <code>unwrap_or_else</code>.</p>
|
||||
<p>The trait bound specified on the generic type <code>F</code> is <code>FnOnce() -> T</code>, which
|
||||
means <code>F</code> must be able to be called once, take no arguments, and return a <code>T</code>.
|
||||
Using <code>FnOnce</code> in the trait bound expresses the constraint that
|
||||
<code>unwrap_or_else</code> will not call <code>f</code> more than once. In the body of
|
||||
<code>unwrap_or_else</code>, we can see that if the <code>Option</code> is <code>Some</code>, <code>f</code> won’t be
|
||||
called. If the <code>Option</code> is <code>None</code>, <code>f</code> will be called once. Because all
|
||||
closures implement <code>FnOnce</code>, <code>unwrap_or_else</code> accepts all three kinds of
|
||||
closures and is as flexible as it can be.</p>
|
||||
<section class="note" aria-role="note">
|
||||
<p>Note: If what we want to do doesn’t require capturing a value from the
|
||||
environment, we can use the name of a function rather than a closure where we
|
||||
need something that implements one of the <code>Fn</code> traits. For example, on an
|
||||
<code>Option<Vec<T>></code> value, we could call <code>unwrap_or_else(Vec::new)</code> to get a
|
||||
new, empty vector if the value is <code>None</code>. The compiler automatically
|
||||
implements whichever of the <code>Fn</code> traits is applicable for a function
|
||||
definition.</p>
|
||||
</section>
|
||||
<p>Now let’s look at the standard library method <code>sort_by_key</code>, defined on slices,
|
||||
to see how that differs from <code>unwrap_or_else</code> and why <code>sort_by_key</code> uses
|
||||
<code>FnMut</code> instead of <code>FnOnce</code> for the trait bound. The closure gets one argument
|
||||
in the form of a reference to the current item in the slice being considered,
|
||||
and it returns a value of type <code>K</code> that can be ordered. This function is useful
|
||||
when you want to sort a slice by a particular attribute of each item. In
|
||||
Listing 13-7, we have a list of <code>Rectangle</code> instances, and we use <code>sort_by_key</code>
|
||||
to order them by their <code>width</code> attribute from low to high.</p>
|
||||
<figure class="listing" id="listing-13-7">
|
||||
<span class="file-name">Filename: src/main.rs</span>
|
||||
<pre class="playground"><code class="language-rust edition2024">#[derive(Debug)]
|
||||
struct Rectangle {
|
||||
width: u32,
|
||||
height: u32,
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let mut list = [
|
||||
Rectangle { width: 10, height: 1 },
|
||||
Rectangle { width: 3, height: 5 },
|
||||
Rectangle { width: 7, height: 12 },
|
||||
];
|
||||
|
||||
list.sort_by_key(|r| r.width);
|
||||
println!("{list:#?}");
|
||||
}</code></pre>
|
||||
<figcaption><a href="#listing-13-7">Listing 13-7</a>: Using <code>sort_by_key</code> to order rectangles by width</figcaption>
|
||||
</figure>
|
||||
<p>This code prints:</p>
|
||||
<pre><code class="language-console">$ cargo run
|
||||
Compiling rectangles v0.1.0 (file:///projects/rectangles)
|
||||
Finished `dev` profile [unoptimized + debuginfo] target(s) in 0.41s
|
||||
Running `target/debug/rectangles`
|
||||
[
|
||||
Rectangle {
|
||||
width: 3,
|
||||
height: 5,
|
||||
},
|
||||
Rectangle {
|
||||
width: 7,
|
||||
height: 12,
|
||||
},
|
||||
Rectangle {
|
||||
width: 10,
|
||||
height: 1,
|
||||
},
|
||||
]
|
||||
</code></pre>
|
||||
<p>The reason <code>sort_by_key</code> is defined to take an <code>FnMut</code> closure is that it calls
|
||||
the closure multiple times: once for each item in the slice. The closure <code>|r| r.width</code> doesn’t capture, mutate, or move anything out from its environment, so
|
||||
it meets the trait bound requirements.</p>
|
||||
<p>In contrast, Listing 13-8 shows an example of a closure that implements just
|
||||
the <code>FnOnce</code> trait, because it moves a value out of the environment. The
|
||||
compiler won’t let us use this closure with <code>sort_by_key</code>.</p>
|
||||
<figure class="listing" id="listing-13-8">
|
||||
<span class="file-name">Filename: src/main.rs</span>
|
||||
<pre><code class="language-rust ignore does_not_compile">#[derive(Debug)]
|
||||
struct Rectangle {
|
||||
width: u32,
|
||||
height: u32,
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let mut list = [
|
||||
Rectangle { width: 10, height: 1 },
|
||||
Rectangle { width: 3, height: 5 },
|
||||
Rectangle { width: 7, height: 12 },
|
||||
];
|
||||
|
||||
let mut sort_operations = vec![];
|
||||
let value = String::from("closure called");
|
||||
|
||||
list.sort_by_key(|r| {
|
||||
sort_operations.push(value);
|
||||
r.width
|
||||
});
|
||||
println!("{list:#?}");
|
||||
}</code></pre>
|
||||
<figcaption><a href="#listing-13-8">Listing 13-8</a>: Attempting to use an <code>FnOnce</code> closure with <code>sort_by_key</code></figcaption>
|
||||
</figure>
|
||||
<p>This is a contrived, convoluted way (that doesn’t work) to try to count the
|
||||
number of times <code>sort_by_key</code> calls the closure when sorting <code>list</code>. This code
|
||||
attempts to do this counting by pushing <code>value</code>—a <code>String</code> from the closure’s
|
||||
environment—into the <code>sort_operations</code> vector. The closure captures <code>value</code> and
|
||||
then moves <code>value</code> out of the closure by transferring ownership of <code>value</code> to
|
||||
the <code>sort_operations</code> vector. This closure can be called once; trying to call
|
||||
it a second time wouldn’t work, because <code>value</code> would no longer be in the
|
||||
environment to be pushed into <code>sort_operations</code> again! Therefore, this closure
|
||||
only implements <code>FnOnce</code>. When we try to compile this code, we get this error
|
||||
that <code>value</code> can’t be moved out of the closure because the closure must
|
||||
implement <code>FnMut</code>:</p>
|
||||
<pre><code class="language-console">$ cargo run
|
||||
Compiling rectangles v0.1.0 (file:///projects/rectangles)
|
||||
error[E0507]: cannot move out of `value`, a captured variable in an `FnMut` closure
|
||||
--> src/main.rs:18:30
|
||||
|
|
||||
15 | let value = String::from("closure called");
|
||||
| ----- ------------------------------ move occurs because `value` has type `String`, which does not implement the `Copy` trait
|
||||
| |
|
||||
| captured outer variable
|
||||
16 |
|
||||
17 | list.sort_by_key(|r| {
|
||||
| --- captured by this `FnMut` closure
|
||||
18 | sort_operations.push(value);
|
||||
| ^^^^^ `value` is moved here
|
||||
|
|
||||
help: consider cloning the value if the performance cost is acceptable
|
||||
|
|
||||
18 | sort_operations.push(value.clone());
|
||||
| ++++++++
|
||||
|
||||
For more information about this error, try `rustc --explain E0507`.
|
||||
error: could not compile `rectangles` (bin "rectangles") due to 1 previous error
|
||||
</code></pre>
|
||||
<p>The error points to the line in the closure body that moves <code>value</code> out of the
|
||||
environment. To fix this, we need to change the closure body so that it doesn’t
|
||||
move values out of the environment. Keeping a counter in the environment and
|
||||
incrementing its value in the closure body is a more straightforward way to
|
||||
count the number of times the closure is called. The closure in Listing 13-9
|
||||
works with <code>sort_by_key</code> because it is only capturing a mutable reference to the
|
||||
<code>num_sort_operations</code> counter and can therefore be called more than once.</p>
|
||||
<figure class="listing" id="listing-13-9">
|
||||
<span class="file-name">Filename: src/main.rs</span>
|
||||
<pre class="playground"><code class="language-rust edition2024">#[derive(Debug)]
|
||||
struct Rectangle {
|
||||
width: u32,
|
||||
height: u32,
|
||||
}
|
||||
|
||||
fn main() {
|
||||
let mut list = [
|
||||
Rectangle { width: 10, height: 1 },
|
||||
Rectangle { width: 3, height: 5 },
|
||||
Rectangle { width: 7, height: 12 },
|
||||
];
|
||||
|
||||
let mut num_sort_operations = 0;
|
||||
list.sort_by_key(|r| {
|
||||
num_sort_operations += 1;
|
||||
r.width
|
||||
});
|
||||
println!("{list:#?}, sorted in {num_sort_operations} operations");
|
||||
}</code></pre>
|
||||
<figcaption><a href="#listing-13-9">Listing 13-9</a>: Using an <code>FnMut</code> closure with <code>sort_by_key</code> is allowed.</figcaption>
|
||||
</figure>
|
||||
<p>The <code>Fn</code> traits are important when defining or using functions or types that
|
||||
make use of closures. In the next section, we’ll discuss iterators. Many
|
||||
iterator methods take closure arguments, so keep these closure details in mind
|
||||
as we continue!</p>
|
||||
|
||||
</main>
|
||||
|
||||
<nav class="nav-wrapper" aria-label="Page navigation">
|
||||
<!-- Mobile navigation buttons -->
|
||||
<a rel="prev" href="ch13-00-functional-features.html" class="mobile-nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||||
</a>
|
||||
|
||||
<a rel="next prefetch" href="ch13-02-iterators.html" class="mobile-nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||||
</a>
|
||||
|
||||
<div style="clear: both"></div>
|
||||
</nav>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<nav class="nav-wide-wrapper" aria-label="Page navigation">
|
||||
<a rel="prev" href="ch13-00-functional-features.html" class="nav-chapters previous" title="Previous chapter" aria-label="Previous chapter" aria-keyshortcuts="Left">
|
||||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M41.4 233.4c-12.5 12.5-12.5 32.8 0 45.3l160 160c12.5 12.5 32.8 12.5 45.3 0s12.5-32.8 0-45.3L109.3 256 246.6 118.6c12.5-12.5 12.5-32.8 0-45.3s-32.8-12.5-45.3 0l-160 160z"/></svg></span>
|
||||
</a>
|
||||
|
||||
<a rel="next prefetch" href="ch13-02-iterators.html" class="nav-chapters next" title="Next chapter" aria-label="Next chapter" aria-keyshortcuts="Right">
|
||||
<span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 320 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M278.6 233.4c12.5 12.5 12.5 32.8 0 45.3l-160 160c-12.5 12.5-32.8 12.5-45.3 0s-12.5-32.8 0-45.3L210.7 256 73.4 118.6c-12.5-12.5-12.5-32.8 0-45.3s32.8-12.5 45.3 0l160 160z"/></svg></span>
|
||||
</a>
|
||||
</nav>
|
||||
|
||||
</div>
|
||||
|
||||
<template id=fa-eye><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M288 32c-80.8 0-145.5 36.8-192.6 80.6C48.6 156 17.3 208 2.5 243.7c-3.3 7.9-3.3 16.7 0 24.6C17.3 304 48.6 356 95.4 399.4C142.5 443.2 207.2 480 288 480s145.5-36.8 192.6-80.6c46.8-43.5 78.1-95.4 93-131.1c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C433.5 68.8 368.8 32 288 32zM432 256c0 79.5-64.5 144-144 144s-144-64.5-144-144s64.5-144 144-144s144 64.5 144 144zM288 192c0 35.3-28.7 64-64 64c-11.5 0-22.3-3-31.6-8.4c-.2 2.8-.4 5.5-.4 8.4c0 53 43 96 96 96s96-43 96-96s-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6z"/></svg></span></template>
|
||||
<template id=fa-eye-slash><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M38.8 5.1C28.4-3.1 13.3-1.2 5.1 9.2S-1.2 34.7 9.2 42.9l592 464c10.4 8.2 25.5 6.3 33.7-4.1s6.3-25.5-4.1-33.7L525.6 386.7c39.6-40.6 66.4-86.1 79.9-118.4c3.3-7.9 3.3-16.7 0-24.6c-14.9-35.7-46.2-87.7-93-131.1C465.5 68.8 400.8 32 320 32c-68.2 0-125 26.3-169.3 60.8L38.8 5.1zM223.1 149.5C248.6 126.2 282.7 112 320 112c79.5 0 144 64.5 144 144c0 24.9-6.3 48.3-17.4 68.7L408 294.5c5.2-11.8 8-24.8 8-38.5c0-53-43-96-96-96c-2.8 0-5.6 .1-8.4 .4c5.3 9.3 8.4 20.1 8.4 31.6c0 10.2-2.4 19.8-6.6 28.3l-90.3-70.8zm223.1 298L373 389.9c-16.4 6.5-34.3 10.1-53 10.1c-79.5 0-144-64.5-144-144c0-6.9 .5-13.6 1.4-20.2L83.1 161.5C60.3 191.2 44 220.8 34.5 243.7c-3.3 7.9-3.3 16.7 0 24.6c14.9 35.7 46.2 87.7 93 131.1C174.5 443.2 239.2 480 320 480c47.8 0 89.9-12.9 126.2-32.5z"/></svg></span></template>
|
||||
<template id=fa-copy><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M502.6 70.63l-61.25-61.25C435.4 3.371 427.2 0 418.7 0H255.1c-35.35 0-64 28.66-64 64l.0195 256C192 355.4 220.7 384 256 384h192c35.2 0 64-28.8 64-64V93.25C512 84.77 508.6 76.63 502.6 70.63zM464 320c0 8.836-7.164 16-16 16H255.1c-8.838 0-16-7.164-16-16L239.1 64.13c0-8.836 7.164-16 16-16h128L384 96c0 17.67 14.33 32 32 32h47.1V320zM272 448c0 8.836-7.164 16-16 16H63.1c-8.838 0-16-7.164-16-16L47.98 192.1c0-8.836 7.164-16 16-16H160V128H63.99c-35.35 0-64 28.65-64 64l.0098 256C.002 483.3 28.66 512 64 512h192c35.2 0 64-28.8 64-64v-32h-47.1L272 448z"/></svg></span></template>
|
||||
<template id=fa-play><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 384 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M73 39c-14.8-9.1-33.4-9.4-48.5-.9S0 62.6 0 80V432c0 17.4 9.4 33.4 24.5 41.9s33.7 8.1 48.5-.9L361 297c14.3-8.7 23-24.2 23-41s-8.7-32.2-23-41L73 39z"/></svg></span></template>
|
||||
<template id=fa-clock-rotate-left><span class=fa-svg><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 6.2.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc. --><path d="M75 75L41 41C25.9 25.9 0 36.6 0 57.9V168c0 13.3 10.7 24 24 24H134.1c21.4 0 32.1-25.9 17-41l-30.8-30.8C155 85.5 203 64 256 64c106 0 192 86 192 192s-86 192-192 192c-40.8 0-78.6-12.7-109.7-34.4c-14.5-10.1-34.4-6.6-44.6 7.9s-6.6 34.4 7.9 44.6C151.2 495 201.7 512 256 512c141.4 0 256-114.6 256-256S397.4 0 256 0C185.3 0 121.3 28.7 75 75zm181 53c-13.3 0-24 10.7-24 24V256c0 6.4 2.5 12.5 7 17l72 72c9.4 9.4 24.6 9.4 33.9 0s9.4-24.6 0-33.9l-65-65V152c0-13.3-10.7-24-24-24z"/></svg></span></template>
|
||||
|
||||
|
||||
|
||||
<script>
|
||||
window.playground_copyable = true;
|
||||
</script>
|
||||
|
||||
|
||||
<script src="elasticlunr-ef4e11c1.min.js"></script>
|
||||
<script src="mark-09e88c2c.min.js"></script>
|
||||
<script src="searcher-09f2665d.js"></script>
|
||||
|
||||
<script src="clipboard-1626706a.min.js"></script>
|
||||
<script src="highlight-abc7f01d.js"></script>
|
||||
<script src="book-c22b7243.js"></script>
|
||||
|
||||
<!-- Custom JS scripts -->
|
||||
<script src="ferris-2317480c.js"></script>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user