2024-07-26 09:42:18 +00:00
<!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 = "Deserializes a string into a type." > < title > from_str in toml - 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 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/index.html" > toml< / a > < span class = "version" > 0.8.15< / span > < / h2 > < / div > < div class = "sidebar-elems" > < / 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< / a > ::< wbr > < a class = "fn" href = "#" > from_str< / 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/de.rs.html#41-46" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub fn from_str< T> (s: & < a class = "primitive" href = "https://doc.rust-lang.org/1.80.0/std/primitive.str.html" > str< / 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 > < T, < a class = "struct" href = "de/struct.Error.html" title = "struct toml::de::Error" > Error< / a > > < div class = "where" > where
2024-03-11 08:39:13 +00:00
T: < a class = "trait" href = "../serde/de/trait.DeserializeOwned.html" title = "trait serde::de::DeserializeOwned" > DeserializeOwned< / a > ,< / div > < / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Deserializes a string into a type.< / p >
< p > This function will attempt to interpret < code > s< / code > as a TOML document and
deserialize < code > T< / code > from the document.< / p >
< p > To deserializes TOML values, instead of documents, see < a href = "de/struct.ValueDeserializer.html" title = "struct toml::de::ValueDeserializer" > < code > ValueDeserializer< / code > < / a > .< / p >
2024-03-27 11:12:16 +00:00
< h2 id = "examples" > < a class = "doc-anchor" href = "#examples" > §< / a > Examples< / h2 >
2024-03-11 08:39:13 +00:00
< div class = "example-wrap" > < pre class = "rust rust-example-rendered" > < code > < span class = "kw" > use < / span > serde::Deserialize;
< span class = "attr" > #[derive(Deserialize)]
< / span > < span class = "kw" > struct < / span > Config {
title: String,
owner: Owner,
}
< span class = "attr" > #[derive(Deserialize)]
< / span > < span class = "kw" > struct < / span > Owner {
name: String,
}
< span class = "kw" > let < / span > config: Config = toml::from_str(< span class = "string" > r#"
title = 'TOML Example'
[owner]
name = 'Lisa'
"#< / span > ).unwrap();
< span class = "macro" > assert_eq!< / span > (config.title, < span class = "string" > "TOML Example"< / span > );
< span class = "macro" > assert_eq!< / span > (config.owner.name, < span class = "string" > "Lisa"< / span > );< / code > < / pre > < / div >
< / div > < / details > < / section > < / div > < / main > < / body > < / html >
