mirror of
https://github.com/edg-l/edlang.git
synced 2024-11-23 00:18:24 +00:00
50 lines
18 KiB
HTML
50 lines
18 KiB
HTML
|
<!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="`toml_edit`"><title>toml_edit - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="toml_edit" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><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 crate"><!--[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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../toml_edit/index.html">toml_edit</a><span class="version">0.22.6</span></h2></div><div class="sidebar-elems"><ul class="block">
|
|||
|
|
<li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section></div></nav><div class="sidebar-resizer"></div>
|
|||
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../toml_edit/all.html" title="show sidebar"></a></div><input class="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"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Crate <a class="mod" href="#">toml_edit</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/toml_edit/lib.rs.html#1-133">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><h2 id="toml_edit"><a href="#toml_edit"><code>toml_edit</code></a></h2>
|
|||
|
|
<p>This crate allows you to parse and modify toml
|
|||
|
|
documents, while preserving comments, spaces <em>and
|
|||
|
|
relative order</em> or items.</p>
|
|||
|
|
<p>If you also need the ease of a more traditional API, see the <a href="https://docs.rs/toml/latest/toml/"><code>toml</code></a> crate.</p>
|
|||
|
|
<h2 id="example"><a href="#example">Example</a></h2>
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>toml_edit::{Document, value};
|
|||
|
|
|
|||
|
|
<span class="kw">let </span>toml = <span class="string">r#"
|
|||
|
|
"hello" = 'toml!' # comment
|
|||
|
|
['a'.b]
|
|||
|
|
"#</span>;
|
|||
|
|
<span class="kw">let </span><span class="kw-2">mut </span>doc = toml.parse::<Document>().expect(<span class="string">"invalid doc"</span>);
|
|||
|
|
<span class="macro">assert_eq!</span>(doc.to_string(), toml);
|
|||
|
|
<span class="comment">// let's add a new key/value pair inside a.b: c = {d = "hello"}
|
|||
|
|
</span>doc[<span class="string">"a"</span>][<span class="string">"b"</span>][<span class="string">"c"</span>][<span class="string">"d"</span>] = value(<span class="string">"hello"</span>);
|
|||
|
|
<span class="comment">// autoformat inline table a.b.c: { d = "hello" }
|
|||
|
|
</span>doc[<span class="string">"a"</span>][<span class="string">"b"</span>][<span class="string">"c"</span>].as_inline_table_mut().map(|t| t.fmt());
|
|||
|
|
<span class="kw">let </span>expected = <span class="string">r#"
|
|||
|
|
"hello" = 'toml!' # comment
|
|||
|
|
['a'.b]
|
|||
|
|
c = { d = "hello" }
|
|||
|
|
"#</span>;
|
|||
|
|
<span class="macro">assert_eq!</span>(doc.to_string(), expected);</code></pre></div>
|
|||
|
|
<h3 id="controlling-formatting"><a href="#controlling-formatting">Controlling formatting</a></h3>
|
|||
|
|
<p>By default, values are created with default formatting</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>doc = toml_edit::Document::new();
|
|||
|
|
doc[<span class="string">"foo"</span>] = toml_edit::value(<span class="string">"bar"</span>);
|
|||
|
|
<span class="kw">let </span>expected = <span class="string">r#"foo = "bar"
|
|||
|
|
"#</span>;
|
|||
|
|
<span class="macro">assert_eq!</span>(doc.to_string(), expected);</code></pre></div>
|
|||
|
|
<p>You can choose a custom TOML representation by parsing the value.</p>
|
|||
|
|
|
|||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>doc = toml_edit::Document::new();
|
|||
|
|
doc[<span class="string">"foo"</span>] = <span class="string">"'bar'"</span>.parse::<toml_edit::Item>().unwrap();
|
|||
|
|
<span class="kw">let </span>expected = <span class="string">r#"foo = 'bar'
|
|||
|
|
"#</span>;
|
|||
|
|
<span class="macro">assert_eq!</span>(doc.to_string(), expected);</code></pre></div>
|
|||
|
|
<h3 id="limitations"><a href="#limitations">Limitations</a></h3>
|
|||
|
|
<p>Things it does not preserve:</p>
|
|||
|
|
<ul>
|
|||
|
|
<li>Order of dotted keys, see <a href="https://github.com/toml-rs/toml/issues/163">issue</a>.</li>
|
|||
|
|
</ul>
|
|||
|
|
</div></details><h2 id="modules" class="section-header"><a href="#modules">Modules</a></h2><ul class="item-table"><li><div class="item-name"><a class="mod" href="de/index.html" title="mod toml_edit::de">de</a></div><div class="desc docblock-short">Deserializing TOML into Rust structures.</div></li><li><div class="item-name"><a class="mod" href="ser/index.html" title="mod toml_edit::ser">ser</a></div><div class="desc docblock-short">Serializing Rust structures into TOML.</div></li><li><div class="item-name"><a class="mod" href="visit/index.html" title="mod toml_edit::visit">visit</a></div><div class="desc docblock-short">Document tree traversal to walk a shared borrow of a document tree.</div></li><li><div class="item-name"><a class="mod" href="visit_mut/index.html" title="mod toml_edit::visit_mut">visit_mut</a></div><div class="desc docblock-short">Document tree traversal to mutate an exclusive borrow of a document tree in place.</div></li></ul><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.Array.html" title="struct toml_edit::Array">Array</a></div><div class="desc docblock-short">Type representing a TOML array,
|
|||
|
|
payload of the <code>Value::Array</code> variant’s value</div></li><li><div class="item-name"><a class="struct" href="struct.ArrayOfTables.html" title="struct toml_edit::ArrayOfTables">ArrayOfTables</a></div><div class="desc docblock-short">Type representing a TOML array of tables</div></li><li><div class="item-name"><a class="struct" href="struct.Date.html" title="struct toml_edit::Date">Date</a></div><div class="desc docblock-short">A parsed TOML date value</div></li><li><div class="item-name"><a class="struct" href="struct.Datetime.html" title="struct toml_edit::Datetime">Datetime</a></div><div class="desc docblock-short">A parsed TOML datetime value</div></li><li><div class="item-name"><a class="struct" href="struct.DatetimeParseError.html" title="struct toml_edit::DatetimeParseError">DatetimeParseError</a></div><div class="desc docblock-short">Error returned from parsing a <code>Datetime</code> in the <code>FromStr</code> implementation.</div></li><li><div class="item-name"><a class="struct" href="struct.Decor.html" title="struct toml_edit::Decor">Decor</a></div><div class="desc docblock-short">A prefix and suffix,</div></li><li><div class="item-name"><a class="struct" href="struct.Document.html" title="struct toml_edit::Document">Document</a></div><div class="desc docblock-short">Type representing a TOML document</div></li><li><div class="item-name"><a class="struct" href="struct.Formatted.html" title="struct toml_edit::Formatted">Formatted</a></div><div class="desc docblock-short">A value together with its <code>to_string</code> representation,
|
|||
|
|
including surrounding it whitespaces and comments.</div></li><li><div class="item-name"><a class="struct" href="struct.InlineOccupiedEntry.html" title="struct toml_edit::InlineOccupiedEntry">InlineOccupiedEntry</a></div><div class="desc docblock-short">A view into a single occupied location in a <code>IndexMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.InlineTable.html" title="struct toml_edit::InlineTable">InlineTable</a></div><div class="desc docblock-short">Type representing a TOML inline table,
|
|||
|
|
payload of the <code>Value::InlineTable</code> variant</div></li><li><div class="item-name"><a class="struct" href="struct.InlineVacantEntry.html" title="struct toml_edit::InlineVacantEntry">InlineVacantEntry</a></div><div class="desc docblock-short">A view into a single empty location in a <code>IndexMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.InternalString.html" title="struct toml_edit::InternalString">InternalString</a></div><div class="desc docblock-short">Opaque string storage internal to <code>toml_edit</code></div></li><li><div class="item-name"><a class="struct" href="struct.Key.html" title="struct toml_edit::Key">Key</a></div><div class="desc docblock-short">Key as part of a Key/Value Pair or a table header.</div></li><li><div class="item-name"><a class="struct" href="struct.KeyMut.html" title="struct toml_edit::KeyMut">KeyMut</a></div><div class="desc docblock-short">A mutable reference to a <code>Key</code>’s formatting</div></li><li><div class="item-name"><a class="struct" href="struct.OccupiedEntry.html" title="struct toml_edit::OccupiedEntry">OccupiedEntry</a></div><div class="desc docblock-short">A view into a single occupied location in a <code>IndexMap</code>.</div></li><li><div class="item-name"><a class="struct" href="struct.RawString.html" title="struct toml_edit::RawString">RawString</a></div><div class="desc docblock-short">Opaque string storage for raw TOML; internal to <code>toml_edit</code></div></li><li><div class="item-name"><a class="struct" href="struct.Repr.html" title="struct toml_edit::Repr">Repr</a></div><div class="desc docblock-short">TOML-encoded value</div></li><li><div class="item-name"><a class="struct" href="struct.Table.html" title="struct toml_edit::Table">Table</a></div><div class="desc docblock-short">Type representing a TOML non-inline table</div></li><li><div class="item-name"><a class="struct" href="struct.Time.html" title="struct toml_edit::Time">Time</a></div><div class="desc docblock-short">A parsed TOML time value</div></li><li><div class="item-name"><a class="struct" href="struct.TomlError.html" title="struct toml_edit::TomlError">TomlError</a></div><div class="desc docblock-short">Type representing a TOML parse error</div></li><li><div class="item-name"><a class="struct" href="struct.VacantEntry.html" title="struct toml_edit::VacantEntry">VacantEntry</a></div><div class="desc docblock-short">A view into a single empty location in a <code>IndexMap</code>.</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.Entry.html" title="enum toml_edit::Entry">Entry</a></div><div class="desc docblock-short">A view into a single location in a map, which may be vacant or occupied.</div></li><li><div class="item-name"><a class="enum" href="enum.InlineEntry.html" title="enum toml_edit::InlineEntry">InlineEntry</a></div><div class="desc docblock-short">A view into a single location in a map, which may be vacant or occupied.</div></li><li><div class="item-name"><a class="enum" href="enum.Item.html" title="enum toml_edit::Item">Item</a></div><div class="desc docblock-short">Type representing either a value, a table, an array of tables, or none.</div></li><li><div class="item-name"><a class="enum" href="enum.Offset.html" title="enum toml_edit::Offset">Offset</a></div><div class="desc docblock-short">A parsed TOML time offset</div></li><li><div class="item-name"><a class="enum" href="enum.Value.html" title="enum toml_edit::Value">Value</a></div><div class="desc docblock-short">Representation of a TOML Value (as part of a Key/Value Pair).</div></li></ul><h2 id="traits" class="section-header"><a href="#traits">Traits</a></h2><ul class="item-table"><li><div class="item-name"><a class="trait" href="trait.TableLike.html" title="trait toml_edit::TableLike">TableLike</a></div><div class="desc docblock-short">This trait represents either a <code>Table</code>, or an <code>InlineTable</code>.</div></li></ul><h2 id="functions" class="section-header"><a hre
|