<!DOCTYPE html><htmllang="en"><head><metacharset="utf-8"><metaname="viewport"content="width=device-width, initial-scale=1.0"><metaname="generator"content="rustdoc"><metaname="description"content="A map of `String` to Value."><title>toml::map - Rust</title><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><linkrel="preload"as="font"type="font/woff2"crossoriginhref="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><linkrel="stylesheet"href="../../static.files/normalize-76eba96aa4d2e634.css"><linkrel="stylesheet"href="../../static.files/rustdoc-5bc39a1768837dd0.css"><metaname="rustdoc-vars"data-root-path="../../"data-static-root-path="../../static.files/"data-current-crate="toml"data-themes=""data-resource-suffix=""data-rustdoc-version="1.77.0 (aedd173a2 2024-03-17)"data-channel="1.77.0"data-search-js="search-dd67cee4cfa65049.js"data-settings-js="settings-4313503d2e1961c2.js"><scriptsrc="../../static.files/storage-4c98445ec4002617.js"></script><scriptdefersrc="../sidebar-items.js"></script><scriptdefersrc="../../static.files/main-48f368f3872407c8.js"></script><noscript><linkrel="stylesheet"href="../../static.files/noscript-04d5337699b92874.css"></noscript><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><linkrel="alternate icon"type="image/png"href="../../static.files/favicon-32x32-422f7d1d52889060.png"><linkrel="icon"type="image/svg+xml"href="../../static.files/favicon-2c020d218678b618.svg"></head><bodyclass="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><navclass="mobile-topbar"><buttonclass="sidebar-menu-toggle"title="show sidebar"></button></nav><navclass="sidebar"><divclass="sidebar-crate"><h2><ahref="../../toml/index.html">toml</a><spanclass="version">0.8.12</span></h2></div><h2class="location"><ahref="#">Module map</a></h2><divclass="sidebar-elems"><section><ulclass="block"><li><ahref="#structs">Structs</a></li><li><ahref="#enums">Enums</a></li></ul></section><h2><ahref="../index.html">In crate toml</a></h2></div></nav><divclass="sidebar-resizer"></div>
<main><divclass="width-limiter"><navclass="sub"><formclass="search-form"><span></span><divid="sidebar-button"tabindex="-1"><ahref="../../toml/all.html"title="show sidebar"></a></div><inputclass="search-input"name="search"aria-label="Run search in the documentation"autocomplete="off"spellcheck="false"placeholder="Click or press ‘S’ to search, ‘?’ for more options…"type="search"><divid="help-button"tabindex="-1"><ahref="../../help.html"title="help">?</a></div><divid="settings-menu"tabindex="-1"><ahref="../../settings.html"title="settings"><imgwidth="22"height="22"alt="Change settings"src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><sectionid="main-content"class="content"><divclass="main-heading"><h1>Module <ahref="../index.html">toml</a>::<wbr><aclass="mod"href="#">map</a><buttonid="copy-path"title="Copy item path to clipboard"><imgsrc="../../static.files/clipboard-7571035ce49a181d.svg"width="19"height="18"alt="Copy item path"></button></h1><spanclass="out-of-band"><aclass="src"href="../../src/toml/map.rs.html#9-609">source</a> · <buttonid="toggle-all-docs"title="collapse all docs">[<span>−</span>]</button></span></div><detailsclass="toggle top-doc"open><summaryclass="hideme"><span>Expand description</span></summary><divclass="docblock"><p>A map of <code>String</code> to <ahref="../enum.Value.html"title="enum toml::Value">Value</a>.</p>
<p>By default the map is backed by a <ahref="https://doc.rust-lang.org/std/collections/struct.BTreeMap.html"><code>BTreeMap</code></a>. Enable the <code>preserve_order</code>
feature of toml-rs to use <ahref="https://docs.rs/indexmap"><code>IndexMap</code></a> instead.</p>
</div></details><h2id="structs"class="section-header">Structs<ahref="#structs"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="struct"href="struct.IntoIter.html"title="struct toml::map::IntoIter">IntoIter</a></div><divclass="desc docblock-short">An owning iterator over a toml::Map’s entries.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Iter.html"title="struct toml::map::Iter">Iter</a></div><divclass="desc docblock-short">An iterator over a toml::Map’s entries.</div></li><li><divclass="item-name"><aclass="struct"href="struct.IterMut.html"title="struct toml::map::IterMut">IterMut</a></div><divclass="desc docblock-short">A mutable iterator over a toml::Map’s entries.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Keys.html"title="struct toml::map::Keys">Keys</a></div><divclass="desc docblock-short">An iterator over a toml::Map’s keys.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Map.html"title="struct toml::map::Map">Map</a></div><divclass="desc docblock-short">Represents a TOML key/value type.</div></li><li><divclass="item-name"><aclass="struct"href="struct.OccupiedEntry.html"title="struct toml::map::OccupiedEntry">OccupiedEntry</a></div><divclass="desc docblock-short">An occupied Entry. It is part of the <ahref="enum.Entry.html"><code>Entry</code></a> enum.</div></li><li><divclass="item-name"><aclass="struct"href="struct.VacantEntry.html"title="struct toml::map::VacantEntry">VacantEntry</a></div><divclass="desc docblock-short">A vacant Entry. It is part of the <ahref="enum.Entry.html"><code>Entry</code></a> enum.</div></li><li><divclass="item-name"><aclass="struct"href="struct.Values.html"title="struct toml::map::Values">Values</a></div><divclass="desc docblock-short">An iterator over a toml::Map’s values.</div></li></ul><h2id="enums"class="section-header">Enums<ahref="#enums"class="anchor">§</a></h2><ulclass="item-table"><li><divclass="item-name"><aclass="enum"href="enum.Entry.html"title="enum toml::map::Entry">Entry</a></div><divclass="desc docblock-short">A view into a single entry in a map, which may either be vacant or occupied.
This enum is constructed from the <ahref="struct.Map.html#method.entry"><code>entry</code></a> method on <ahref="struct.Map.html"><code>Map</code></a>.</div></li></ul></section></div></main></body></html>
