| <!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 serde-compatible TOML-parsing library"><meta name="keywords" content="rust, rustlang, rust-lang, toml"><title>toml - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="../crates.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.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><a class="sidebar-logo" href="../toml/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../toml/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Crate toml</a></h2><div class="sidebar-elems"><ul class="block"><li class="version">Version 0.5.11</li><li><a id="all-types" href="all.html">All Items</a></li></ul><section><ul class="block"><li><a href="#reexports">Re-exports</a></li><li><a href="#modules">Modules</a></li><li><a href="#macros">Macros</a></li><li><a href="#structs">Structs</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Crate <a class="mod" href="#">toml</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/toml/lib.rs.html#1-176">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A <a href="https://serde.rs/">serde</a>-compatible <a href="https://github.com/toml-lang/toml">TOML</a>-parsing library</p> |
| <p>TOML itself is a simple, ergonomic, and readable configuration format:</p> |
| <div class="example-wrap"><pre class="language-toml"><code>[package] |
| name = "toml" |
| version = "0.4.2" |
| authors = ["Alex Crichton <alex@alexcrichton.com>"] |
| |
| [dependencies] |
| serde = "1.0"</code></pre></div> |
| <p>The TOML format tends to be relatively common throughout the Rust community |
| for configuration, notably being used by <a href="https://crates.io/">Cargo</a>, Rust’s package manager.</p> |
| <h3 id="toml-values"><a href="#toml-values">TOML values</a></h3> |
| <p>A value in TOML is represented with the <a href="value/enum.Value.html" title="Value"><code>Value</code></a> enum in this crate:</p> |
| |
| <div class="example-wrap ignore"><div class='tooltip'>ⓘ</div><pre class="rust rust-example-rendered"><code><span class="kw">pub enum </span>Value { |
| String(String), |
| Integer(i64), |
| Float(f64), |
| Boolean(bool), |
| Datetime(Datetime), |
| Array(Array), |
| Table(Table), |
| }</code></pre></div> |
| <p>TOML is similar to JSON with the notable addition of a <a href="value/struct.Datetime.html" title="Datetime"><code>Datetime</code></a> |
| type. In general, TOML and JSON are interchangeable in terms of |
| formats.</p> |
| <h3 id="parsing-toml"><a href="#parsing-toml">Parsing TOML</a></h3> |
| <p>The easiest way to parse a TOML document is via the <a href="value/enum.Value.html" title="Value"><code>Value</code></a> type:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>toml::Value; |
| |
| <span class="kw">let </span>value = <span class="string">"foo = 'bar'"</span>.parse::<Value>().unwrap(); |
| |
| <span class="macro">assert_eq!</span>(value[<span class="string">"foo"</span>].as_str(), <span class="prelude-val">Some</span>(<span class="string">"bar"</span>));</code></pre></div> |
| <p>The <a href="value/enum.Value.html" title="Value"><code>Value</code></a> type implements a number of convenience methods and |
| traits; the example above uses [<code>FromStr</code>] to parse a [<code>str</code>] into a |
| <a href="value/enum.Value.html" title="Value"><code>Value</code></a>.</p> |
| <h3 id="deserialization-and-serialization"><a href="#deserialization-and-serialization">Deserialization and Serialization</a></h3> |
| <p>This crate supports <a href="https://serde.rs/"><code>serde</code></a> 1.0 with a number of |
| implementations of the <code>Deserialize</code>, <code>Serialize</code>, <code>Deserializer</code>, and |
| <code>Serializer</code> traits. Namely, you’ll find:</p> |
| <ul> |
| <li><code>Deserialize for Value</code></li> |
| <li><code>Serialize for Value</code></li> |
| <li><code>Deserialize for Datetime</code></li> |
| <li><code>Serialize for Datetime</code></li> |
| <li><code>Deserializer for de::Deserializer</code></li> |
| <li><code>Serializer for ser::Serializer</code></li> |
| <li><code>Deserializer for Value</code></li> |
| </ul> |
| <p>This means that you can use Serde to deserialize/serialize the |
| <a href="value/enum.Value.html" title="Value"><code>Value</code></a> type as well as the <a href="value/struct.Datetime.html" title="Datetime"><code>Datetime</code></a> type in this crate. You can also |
| use the <a href="de/struct.Deserializer.html" title="Deserializer"><code>Deserializer</code></a>, <a href="ser/struct.Serializer.html" title="Serializer"><code>Serializer</code></a>, or <a href="value/enum.Value.html" title="Value"><code>Value</code></a> type itself to act as |
| a deserializer/serializer for arbitrary types.</p> |
| <p>An example of deserializing with TOML is:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde_derive::Deserialize; |
| |
| <span class="attribute">#[derive(Deserialize)] |
| </span><span class="kw">struct </span>Config { |
| ip: String, |
| port: <span class="prelude-ty">Option</span><u16>, |
| keys: Keys, |
| } |
| |
| <span class="attribute">#[derive(Deserialize)] |
| </span><span class="kw">struct </span>Keys { |
| github: String, |
| travis: <span class="prelude-ty">Option</span><String>, |
| } |
| |
| <span class="kw">fn </span>main() { |
| <span class="kw">let </span>config: Config = toml::from_str(<span class="string">r#" |
| ip = '127.0.0.1' |
| |
| [keys] |
| github = 'xxxxxxxxxxxxxxxxx' |
| travis = 'yyyyyyyyyyyyyyyyy' |
| "#</span>).unwrap(); |
| |
| <span class="macro">assert_eq!</span>(config.ip, <span class="string">"127.0.0.1"</span>); |
| <span class="macro">assert_eq!</span>(config.port, <span class="prelude-val">None</span>); |
| <span class="macro">assert_eq!</span>(config.keys.github, <span class="string">"xxxxxxxxxxxxxxxxx"</span>); |
| <span class="macro">assert_eq!</span>(config.keys.travis.as_ref().unwrap(), <span class="string">"yyyyyyyyyyyyyyyyy"</span>); |
| }</code></pre></div> |
| <p>You can serialize types in a similar fashion:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde_derive::Serialize; |
| |
| <span class="attribute">#[derive(Serialize)] |
| </span><span class="kw">struct </span>Config { |
| ip: String, |
| port: <span class="prelude-ty">Option</span><u16>, |
| keys: Keys, |
| } |
| |
| <span class="attribute">#[derive(Serialize)] |
| </span><span class="kw">struct </span>Keys { |
| github: String, |
| travis: <span class="prelude-ty">Option</span><String>, |
| } |
| |
| <span class="kw">fn </span>main() { |
| <span class="kw">let </span>config = Config { |
| ip: <span class="string">"127.0.0.1"</span>.to_string(), |
| port: <span class="prelude-val">None</span>, |
| keys: Keys { |
| github: <span class="string">"xxxxxxxxxxxxxxxxx"</span>.to_string(), |
| travis: <span class="prelude-val">Some</span>(<span class="string">"yyyyyyyyyyyyyyyyy"</span>.to_string()), |
| }, |
| }; |
| |
| <span class="kw">let </span>toml = toml::to_string(<span class="kw-2">&</span>config).unwrap(); |
| }</code></pre></div> |
| </div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2><div class="item-table"><div class="item-row"><div class="item-left import-item" id="reexport.Value"><code>pub use crate::value::<a class="enum" href="value/enum.Value.html" title="enum toml::value::Value">Value</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.to_string"><code>pub use crate::ser::<a class="fn" href="ser/fn.to_string.html" title="fn toml::ser::to_string">to_string</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.to_string_pretty"><code>pub use crate::ser::<a class="fn" href="ser/fn.to_string_pretty.html" title="fn toml::ser::to_string_pretty">to_string_pretty</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.to_vec"><code>pub use crate::ser::<a class="fn" href="ser/fn.to_vec.html" title="fn toml::ser::to_vec">to_vec</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Serializer"><code>pub use crate::ser::<a class="struct" href="ser/struct.Serializer.html" title="struct toml::ser::Serializer">Serializer</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.from_slice"><code>pub use crate::de::<a class="fn" href="de/fn.from_slice.html" title="fn toml::de::from_slice">from_slice</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.from_str"><code>pub use crate::de::<a class="fn" href="de/fn.from_str.html" title="fn toml::de::from_str">from_str</a>;</code></div></div><div class="item-row"><div class="item-left import-item" id="reexport.Deserializer"><code>pub use crate::de::<a class="struct" href="de/struct.Deserializer.html" title="struct toml::de::Deserializer">Deserializer</a>;</code></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="de/index.html" title="toml::de mod">de</a></div><div class="item-right docblock-short">Deserializing TOML into Rust structures.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="map/index.html" title="toml::map mod">map</a></div><div class="item-right docblock-short">A map of String to toml::Value.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="ser/index.html" title="toml::ser mod">ser</a></div><div class="item-right docblock-short">Serializing Rust structures into TOML.</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="value/index.html" title="toml::value mod">value</a></div><div class="item-right docblock-short">Definition of a TOML value</div></div></div><h2 id="macros" class="small-section-header"><a href="#macros">Macros</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="macro" href="macro.toml.html" title="toml::toml macro">toml</a></div><div class="item-right docblock-short">Construct a <a href="value/enum.Value.html"><code>toml::Value</code></a> from TOML syntax.</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Spanned.html" title="toml::Spanned struct">Spanned</a></div><div class="item-right docblock-short">A spanned value, indicating the range at which it is defined in the source.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="toml" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
