edlang/toml/map/index.html
2024-08-01 07:04:26 +00:00

5 lines
5.7 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A map of `String` to Value."><title>toml::map - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-dd39b87e5fcfba68.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="toml" data-themes="" data-resource-suffix="" data-rustdoc-version="1.80.0 (051478957 2024-07-21)" data-channel="1.80.0" data-search-js="search-d52510db62a78183.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-118b08c4c78b968e.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-20a3ad099b048cf2.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-df360f571f6edeae.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../toml/index.html">toml</a><span class="version">0.8.19</span></h2></div><h2 class="location"><a href="#">Module map</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section><h2><a href="../index.html">In crate toml</a></h2></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../index.html">toml</a>::<wbr><a class="mod" href="#">map</a><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><span class="out-of-band"><a class="src" href="../../src/toml/map.rs.html#9-609">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A map of <code>String</code> to <a href="../enum.Value.html" title="enum toml::Value">Value</a>.</p>
<p>By default the map is backed by a <a href="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 <a href="https://docs.rs/indexmap"><code>IndexMap</code></a> instead.</p>
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.IntoIter.html" title="struct toml::map::IntoIter">IntoIter</a></div><div class="desc docblock-short">An owning iterator over a <code>toml::Map</code>s entries.</div></li><li><div class="item-name"><a class="struct" href="struct.Iter.html" title="struct toml::map::Iter">Iter</a></div><div class="desc docblock-short">An iterator over a <code>toml::Map</code>s entries.</div></li><li><div class="item-name"><a class="struct" href="struct.IterMut.html" title="struct toml::map::IterMut">IterMut</a></div><div class="desc docblock-short">A mutable iterator over a <code>toml::Map</code>s entries.</div></li><li><div class="item-name"><a class="struct" href="struct.Keys.html" title="struct toml::map::Keys">Keys</a></div><div class="desc docblock-short">An iterator over a <code>toml::Map</code>s keys.</div></li><li><div class="item-name"><a class="struct" href="struct.Map.html" title="struct toml::map::Map">Map</a></div><div class="desc docblock-short">Represents a TOML key/value type.</div></li><li><div class="item-name"><a class="struct" href="struct.OccupiedEntry.html" title="struct toml::map::OccupiedEntry">OccupiedEntry</a></div><div class="desc docblock-short">An occupied Entry. It is part of the <a href="enum.Entry.html"><code>Entry</code></a> enum.</div></li><li><div class="item-name"><a class="struct" href="struct.VacantEntry.html" title="struct toml::map::VacantEntry">VacantEntry</a></div><div class="desc docblock-short">A vacant Entry. It is part of the <a href="enum.Entry.html"><code>Entry</code></a> enum.</div></li><li><div class="item-name"><a class="struct" href="struct.Values.html" title="struct toml::map::Values">Values</a></div><div class="desc docblock-short">An iterator over a <code>toml::Map</code>s values.</div></li></ul><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Entry.html" title="enum toml::map::Entry">Entry</a></div><div class="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 <a href="struct.Map.html#method.entry"><code>entry</code></a> method on <a href="struct.Map.html"><code>Map</code></a>.</div></li></ul></section></div></main></body></html>