mirror of
https://github.com/edg-l/edlang.git
synced 2024-10-18 15:08:17 +00:00
33 lines
5.2 KiB
HTML
33 lines
5.2 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="Serialize the given data structure as a String of TOML."><title>to_string in toml_edit::ser - 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_edit" 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 fn"><!--[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_edit/index.html">toml_edit</a><span class="version">0.22.20</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In toml_edit::ser</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>Function <a href="../index.html">toml_edit</a>::<wbr><a href="index.html">ser</a>::<wbr><a class="fn" href="#">to_string</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_edit/ser/mod.rs.html#132-137">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn to_string<T>(value: <a class="primitive" href="https://doc.rust-lang.org/1.80.0/std/primitive.reference.html">&T</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.80.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="https://doc.rust-lang.org/1.80.0/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <a class="enum" href="enum.Error.html" title="enum toml_edit::ser::Error">Error</a>><div class="where">where
|
||
T: <a class="trait" href="../../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.80.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Serialize the given data structure as a String of TOML.</p>
|
||
<p>Serialization can fail if <code>T</code>’s implementation of <code>Serialize</code> decides to
|
||
fail, if <code>T</code> contains a map with non-string keys, or if <code>T</code> attempts to
|
||
serialize an unsupported datatype such as an enum, tuple, or tuple struct.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>serde::Serialize;
|
||
|
||
<span class="attr">#[derive(Serialize)]
|
||
</span><span class="kw">struct </span>Config {
|
||
database: Database,
|
||
}
|
||
|
||
<span class="attr">#[derive(Serialize)]
|
||
</span><span class="kw">struct </span>Database {
|
||
ip: String,
|
||
port: Vec<u16>,
|
||
connection_max: u32,
|
||
enabled: bool,
|
||
}
|
||
|
||
<span class="kw">let </span>config = Config {
|
||
database: Database {
|
||
ip: <span class="string">"192.168.1.1"</span>.to_string(),
|
||
port: <span class="macro">vec!</span>[<span class="number">8001</span>, <span class="number">8002</span>, <span class="number">8003</span>],
|
||
connection_max: <span class="number">5000</span>,
|
||
enabled: <span class="bool-val">false</span>,
|
||
},
|
||
};
|
||
|
||
<span class="kw">let </span>toml = toml_edit::ser::to_string(<span class="kw-2">&</span>config).unwrap();
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, toml)</code></pre></div>
|
||
</div></details></section></div></main></body></html> |