2024-05-05 09:43:20 +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 = "Provides a `Visitor` access to each element of a sequence in the input." > < title > SeqAccess in serde::de - Rust< / title > < script > if ( window . location . protocol !== "file:" ) document . write ( ` <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"> ` ) < / script > < link rel = "stylesheet" href = "../../static.files/normalize-76eba96aa4d2e634.css" > < link rel = "stylesheet" href = "../../static.files/rustdoc-e935ef01ae1c1829.css" > < meta name = "rustdoc-vars" data-root-path = "../../" data-static-root-path = "../../static.files/" data-current-crate = "serde" data-themes = "" data-resource-suffix = "" data-rustdoc-version = "1.78.0 (9b00956e5 2024-04-29)" data-channel = "1.78.0" data-search-js = "search-42d8da7a6b9792c2.js" data-settings-js = "settings-4313503d2e1961c2.js" > < script src = "../../static.files/storage-4c98445ec4002617.js" > < / script > < script defer src = "sidebar-items.js" > < / script > < script defer src = "../../static.files/main-12cf3b4f4f9dc36d.js" > < / script > < noscript > < link rel = "stylesheet" href = "../../static.files/noscript-04d5337699b92874.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 trait" > <!-- [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 = "../../serde/index.html" > serde< / a > < span class = "version" > 1.0.200< / span > < / h2 > < / div > < h2 class = "location" > < a href = "#" > SeqAccess< / a > < / h2 > < div class = "sidebar-elems" > < section > < h3 > < a href = "#required-associated-types" > Required Associated Types< / a > < / h3 > < ul class = "block" > < li > < a href = "#associatedtype.Error" > Error< / a > < / li > < / ul > < h3 > < a href = "#required-methods" > Required Methods< / a > < / h3 > < ul class = "block" > < li > < a href = "#tymethod.next_element_seed" > next_element_seed< / a > < / li > < / ul > < h3 > < a href = "#provided-methods" > Provided Methods< / a > < / h3 > < ul class = "block" > < li > < a href = "#method.next_element" > next_element< / a > < / li > < li > < a href = "#method.size_hint" > size_hint< / a > < / li > < / ul > < h3 > < a href = "#foreign-impls" > Implementations on Foreign Types< / a > < / h3 > < ul class = "block" > < li > < a href = "#impl-SeqAccess%3C'de%3E-for-%26mut+A" > & ' a mut A< / a > < / li > < / ul > < h3 > < a href = "#object-safety" > Object Safety< / a > < / h3 > < h3 > < a href = "#implementors" > Implementors< / a > < / h3 > < / section > < h2 > < a href = "index.html" > In serde::de< / a > < / h2 > < / div > < / nav > < div class = "sidebar-resizer" > < / div >
2024-03-11 08:39:13 +00:00
< main > < div class = "width-limiter" > < nav class = "sub" > < form class = "search-form" > < span > < / span > < div id = "sidebar-button" tabindex = "-1" > < a href = "../../serde/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 ‘ ’ ‘ ’ 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 > Trait < a href = "../index.html" > serde< / a > ::< wbr > < a href = "index.html" > de< / a > ::< wbr > < a class = "trait" href = "#" > SeqAccess< / 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/serde/de/mod.rs.html#1704-1736" > source< / a > · < button id = "toggle-all-docs" title = "collapse all docs" > [< span > − < / span > ]< / button > < / span > < / div > < pre class = "rust item-decl" > < code > pub trait SeqAccess< 'de> {
type < a href = "#associatedtype.Error" class = "associatedtype" > Error< / a > : < a class = "trait" href = "trait.Error.html" title = "trait serde::de::Error" > Error< / a > ;
// Required method
fn < a href = "#tymethod.next_element_seed" class = "fn" > next_element_seed< / a > < T> (
& mut self,
seed: T
2024-05-05 09:43:20 +00:00
) -> < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < T::< a class = "associatedtype" href = "trait.DeserializeSeed.html#associatedtype.Value" title = "type serde::de::DeserializeSeed::Value" > Value< / a > > , Self::< a class = "associatedtype" href = "trait.SeqAccess.html#associatedtype.Error" title = "type serde::de::SeqAccess::Error" > Error< / a > >
2024-03-11 08:39:13 +00:00
< span class = "where" > where T: < a class = "trait" href = "trait.DeserializeSeed.html" title = "trait serde::de::DeserializeSeed" > DeserializeSeed< / a > < 'de> < / span > ;
// Provided methods
2024-05-05 09:43:20 +00:00
fn < a href = "#method.next_element" class = "fn" > next_element< / a > < T> (& mut self) -> < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < T> , Self::< a class = "associatedtype" href = "trait.SeqAccess.html#associatedtype.Error" title = "type serde::de::SeqAccess::Error" > Error< / a > >
2024-03-11 08:39:13 +00:00
< span class = "where" > where T: < a class = "trait" href = "../trait.Deserialize.html" title = "trait serde::Deserialize" > Deserialize< / a > < 'de> < / span > { ... }
2024-05-05 09:43:20 +00:00
< span class = "item-spacer" > < / span > fn < a href = "#method.size_hint" class = "fn" > size_hint< / a > (& self) -> < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.usize.html" > usize< / a > > { ... }
2024-03-11 08:39:13 +00:00
}< / code > < / pre > < details class = "toggle top-doc" open > < summary class = "hideme" > < span > Expand description< / span > < / summary > < div class = "docblock" > < p > Provides a < code > Visitor< / code > access to each element of a sequence in the input.< / p >
< p > This is a trait that a < code > Deserializer< / code > passes to a < code > Visitor< / code > implementation,
which deserializes each item in a sequence.< / p >
2024-03-27 11:12:16 +00:00
< h2 id = "lifetime" > < a class = "doc-anchor" href = "#lifetime" > §< / a > Lifetime< / h2 >
2024-03-11 08:39:13 +00:00
< p > The < code > 'de< / code > lifetime of this trait is the lifetime of data that may be
borrowed by deserialized sequence elements. See the page < a href = "https://serde.rs/lifetimes.html" > Understanding
deserializer lifetimes< / a > for a more detailed explanation of these lifetimes.< / p >
2024-03-27 11:12:16 +00:00
< h2 id = "example-implementation" > < a class = "doc-anchor" href = "#example-implementation" > §< / a > Example implementation< / h2 >
2024-03-11 08:39:13 +00:00
< p > The < a href = "https://serde.rs/data-format.html" > example data format< / a > presented on the website demonstrates an
implementation of < code > SeqAccess< / code > for a basic JSON data format.< / p >
< / div > < / details > < h2 id = "required-associated-types" class = "section-header" > Required Associated Types< a href = "#required-associated-types" class = "anchor" > §< / a > < / h2 > < div class = "methods" > < details class = "toggle" open > < summary > < section id = "associatedtype.Error" class = "method" > < a class = "src rightside" href = "../../src/serde/de/mod.rs.html#1707" > source< / a > < h4 class = "code-header" > type < a href = "#associatedtype.Error" class = "associatedtype" > Error< / a > : < a class = "trait" href = "trait.Error.html" title = "trait serde::de::Error" > Error< / a > < / h4 > < / section > < / summary > < div class = "docblock" > < p > The error type that can be returned if some error occurs during
deserialization.< / p >
< / div > < / details > < / div > < h2 id = "required-methods" class = "section-header" > Required Methods< a href = "#required-methods" class = "anchor" > §< / a > < / h2 > < div class = "methods" > < details class = "toggle method-toggle" open > < summary > < section id = "tymethod.next_element_seed" class = "method" > < a class = "src rightside" href = "../../src/serde/de/mod.rs.html#1714-1716" > source< / a > < h4 class = "code-header" > fn < a href = "#tymethod.next_element_seed" class = "fn" > next_element_seed< / a > < T> (
& mut self,
seed: T
2024-05-05 09:43:20 +00:00
) -> < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < T::< a class = "associatedtype" href = "trait.DeserializeSeed.html#associatedtype.Value" title = "type serde::de::DeserializeSeed::Value" > Value< / a > > , Self::< a class = "associatedtype" href = "trait.SeqAccess.html#associatedtype.Error" title = "type serde::de::SeqAccess::Error" > Error< / a > > < div class = "where" > where
2024-03-11 08:39:13 +00:00
T: < a class = "trait" href = "trait.DeserializeSeed.html" title = "trait serde::de::DeserializeSeed" > DeserializeSeed< / a > < 'de> ,< / div > < / h4 > < / section > < / summary > < div class = "docblock" > < p > This returns < code > Ok(Some(value))< / code > for the next value in the sequence, or
< code > Ok(None)< / code > if there are no more remaining items.< / p >
< p > < code > Deserialize< / code > implementations should typically use
< code > SeqAccess::next_element< / code > instead.< / p >
2024-05-05 09:43:20 +00:00
< / div > < / details > < / div > < h2 id = "provided-methods" class = "section-header" > Provided Methods< a href = "#provided-methods" class = "anchor" > §< / a > < / h2 > < div class = "methods" > < details class = "toggle method-toggle" open > < summary > < section id = "method.next_element" class = "method" > < a class = "src rightside" href = "../../src/serde/de/mod.rs.html#1724-1729" > source< / a > < h4 class = "code-header" > fn < a href = "#method.next_element" class = "fn" > next_element< / a > < T> (& mut self) -> < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < T> , Self::< a class = "associatedtype" href = "trait.SeqAccess.html#associatedtype.Error" title = "type serde::de::SeqAccess::Error" > Error< / a > > < div class = "where" > where
2024-03-11 08:39:13 +00:00
T: < a class = "trait" href = "../trait.Deserialize.html" title = "trait serde::Deserialize" > Deserialize< / a > < 'de> ,< / div > < / h4 > < / section > < / summary > < div class = "docblock" > < p > This returns < code > Ok(Some(value))< / code > for the next value in the sequence, or
< code > Ok(None)< / code > if there are no more remaining items.< / p >
< p > This method exists as a convenience for < code > Deserialize< / code > implementations.
< code > SeqAccess< / code > implementations should not override the default behavior.< / p >
2024-05-05 09:43:20 +00:00
< / div > < / details > < details class = "toggle method-toggle" open > < summary > < section id = "method.size_hint" class = "method" > < a class = "src rightside" href = "../../src/serde/de/mod.rs.html#1733-1735" > source< / a > < h4 class = "code-header" > fn < a href = "#method.size_hint" class = "fn" > size_hint< / a > (& self) -> < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.usize.html" > usize< / a > > < / h4 > < / section > < / summary > < div class = "docblock" > < p > Returns the number of elements remaining in the sequence, if known.< / p >
< / div > < / details > < / div > < h2 id = "object-safety" class = "section-header" > Object Safety< a href = "#object-safety" class = "anchor" > §< / a > < / h2 > < div class = "object-safety-info" > This trait is < b > not< / b > < a href = "https://doc.rust-lang.org/1.78.0/reference/items/traits.html#object-safety" > object safe< / a > .< / div > < h2 id = "foreign-impls" class = "section-header" > Implementations on Foreign Types< a href = "#foreign-impls" class = "anchor" > §< / a > < / h2 > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-SeqAccess%3C'de%3E-for-%26mut+A" class = "impl" > < a class = "src rightside" href = "../../src/serde/de/mod.rs.html#1738-1764" > source< / a > < a href = "#impl-SeqAccess%3C'de%3E-for-%26mut+A" class = "anchor" > §< / a > < h3 class = "code-header" > impl< 'de, 'a, A> < a class = "trait" href = "trait.SeqAccess.html" title = "trait serde::de::SeqAccess" > SeqAccess< / a > < 'de> for < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.reference.html" > & 'a mut A< / a > < div class = "where" > where
A: ?< a class = "trait" href = "https://doc.rust-lang.org/1.78.0/core/marker/trait.Sized.html" title = "trait core::marker::Sized" > Sized< / a > + < a class = "trait" href = "trait.SeqAccess.html" title = "trait serde::de::SeqAccess" > SeqAccess< / a > < 'de> ,< / div > < / h3 > < / section > < / summary > < div class = "impl-items" > < section id = "associatedtype.Error-1" class = "associatedtype trait-impl" > < a href = "#associatedtype.Error-1" class = "anchor" > §< / a > < h4 class = "code-header" > type < a href = "#associatedtype.Error" class = "associatedtype" > Error< / a > = < A as < a class = "trait" href = "trait.SeqAccess.html" title = "trait serde::de::SeqAccess" > SeqAccess< / a > < 'de> > ::< a class = "associatedtype" href = "trait.SeqAccess.html#associatedtype.Error" title = "type serde::de::SeqAccess::Error" > Error< / a > < / h4 > < / section > < section id = "method.next_element_seed" class = "method trait-impl" > < a class = "src rightside" href = "../../src/serde/de/mod.rs.html#1745-1750" > source< / a > < a href = "#method.next_element_seed" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "#tymethod.next_element_seed" class = "fn" > next_element_seed< / a > < T> (
2024-03-11 08:39:13 +00:00
& mut self,
seed: T
2024-05-05 09:43:20 +00:00
) -> < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < T::< a class = "associatedtype" href = "trait.DeserializeSeed.html#associatedtype.Value" title = "type serde::de::DeserializeSeed::Value" > Value< / a > > , Self::< a class = "associatedtype" href = "trait.SeqAccess.html#associatedtype.Error" title = "type serde::de::SeqAccess::Error" > Error< / a > > < div class = "where" > where
T: < a class = "trait" href = "trait.DeserializeSeed.html" title = "trait serde::de::DeserializeSeed" > DeserializeSeed< / a > < 'de> ,< / div > < / h4 > < / section > < section id = "method.next_element-1" class = "method trait-impl" > < a class = "src rightside" href = "../../src/serde/de/mod.rs.html#1753-1758" > source< / a > < a href = "#method.next_element-1" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "#method.next_element" class = "fn" > next_element< / a > < T> (& mut self) -> < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/result/enum.Result.html" title = "enum core::result::Result" > Result< / a > < < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < T> , Self::< a class = "associatedtype" href = "trait.SeqAccess.html#associatedtype.Error" title = "type serde::de::SeqAccess::Error" > Error< / a > > < div class = "where" > where
T: < a class = "trait" href = "../trait.Deserialize.html" title = "trait serde::Deserialize" > Deserialize< / a > < 'de> ,< / div > < / h4 > < / section > < section id = "method.size_hint-1" class = "method trait-impl" > < a class = "src rightside" href = "../../src/serde/de/mod.rs.html#1761-1763" > source< / a > < a href = "#method.size_hint-1" class = "anchor" > §< / a > < h4 class = "code-header" > fn < a href = "#method.size_hint" class = "fn" > size_hint< / a > (& self) -> < a class = "enum" href = "https://doc.rust-lang.org/1.78.0/core/option/enum.Option.html" title = "enum core::option::Option" > Option< / a > < < a class = "primitive" href = "https://doc.rust-lang.org/1.78.0/std/primitive.usize.html" > usize< / a > > < / h4 > < / section > < / div > < / details > < h2 id = "implementors" class = "section-header" > Implementors< a href = "#implementors" class = "anchor" > §< / a > < / h2 > < div id = "implementors-list" > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-SeqAccess%3C'de%3E-for-MapDeserializer%3C'de,+I,+E%3E" class = "impl" > < a class = "src rightside" href = "../../src/serde/de/value.rs.html#1258-1284" > source< / a > < a href = "#impl-SeqAccess%3C'de%3E-for-MapDeserializer%3C'de,+I,+E%3E" class = "anchor" > §< / a > < h3 class = "code-header" > impl< 'de, I, E> < a class = "trait" href = "trait.SeqAccess.html" title = "trait serde::de::SeqAccess" > SeqAccess< / a > < 'de> for < a class = "struct" href = "value/struct.MapDeserializer.html" title = "struct serde::de::value::MapDeserializer" > MapDeserializer< / a > < 'de, I, E> < div class = "where" > where
I: < a class = "trait" href = "https://doc.rust-lang.org/1.78.0/core/iter/traits/iterator/trait.Iterator.html" title = "trait core::iter::traits::iterator::Iterator" > Iterator< / a > ,
I::< a class = "associatedtype" href = "https://doc.rust-lang.org/1.78.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" title = "type core::iter::traits::iterator::Iterator::Item" > Item< / a > : Pair,
< I::< a class = "associatedtype" href = "https://doc.rust-lang.org/1.78.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" title = "type core::iter::traits::iterator::Iterator::Item" > Item< / a > as Pair> ::First: < a class = "trait" href = "trait.IntoDeserializer.html" title = "trait serde::de::IntoDeserializer" > IntoDeserializer< / a > < 'de, E> ,
< I::< a class = "associatedtype" href = "https://doc.rust-lang.org/1.78.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" title = "type core::iter::traits::iterator::Iterator::Item" > Item< / a > as Pair> ::Second: < a class = "trait" href = "trait.IntoDeserializer.html" title = "trait serde::de::IntoDeserializer" > IntoDeserializer< / a > < 'de, E> ,
2024-03-11 08:39:13 +00:00
E: < a class = "trait" href = "trait.Error.html" title = "trait serde::de::Error" > Error< / a > ,< / div > < / h3 > < / section > < / summary > < div class = "impl-items" > < section id = "associatedtype.Error-2" class = "associatedtype trait-impl" > < a href = "#associatedtype.Error-2" class = "anchor" > §< / a > < h4 class = "code-header" > type < a href = "#associatedtype.Error" class = "associatedtype" > Error< / a > = E< / h4 > < / section > < / div > < / details > < details class = "toggle implementors-toggle" > < summary > < section id = "impl-SeqAccess%3C'de%3E-for-SeqDeserializer%3CI,+E%3E" class = "impl" > < a class = "src rightside" href = "../../src/serde/de/value.rs.html#955-979" > source< / a > < a href = "#impl-SeqAccess%3C'de%3E-for-SeqDeserializer%3CI,+E%3E" class = "anchor" > §< / a > < h3 class = "code-header" > impl< 'de, I, T, E> < a class = "trait" href = "trait.SeqAccess.html" title = "trait serde::de::SeqAccess" > SeqAccess< / a > < 'de> for < a class = "struct" href = "value/struct.SeqDeserializer.html" title = "struct serde::de::value::SeqDeserializer" > SeqDeserializer< / a > < I, E> < div class = "where" > where
2024-05-05 09:43:20 +00:00
I: < a class = "trait" href = "https://doc.rust-lang.org/1.78.0/core/iter/traits/iterator/trait.Iterator.html" title = "trait core::iter::traits::iterator::Iterator" > Iterator< / a > < Item = T> ,
2024-03-11 08:39:13 +00:00
T: < a class = "trait" href = "trait.IntoDeserializer.html" title = "trait serde::de::IntoDeserializer" > IntoDeserializer< / a > < 'de, E> ,
E: < a class = "trait" href = "trait.Error.html" title = "trait serde::de::Error" > Error< / a > ,< / div > < / h3 > < / section > < / summary > < div class = "impl-items" > < section id = "associatedtype.Error-3" class = "associatedtype trait-impl" > < a href = "#associatedtype.Error-3" class = "anchor" > §< / a > < h4 class = "code-header" > type < a href = "#associatedtype.Error" class = "associatedtype" > Error< / a > = E< / h4 > < / section > < / div > < / details > < / div > < script src = "../../trait.impl/serde/de/trait.SeqAccess.js" async > < / script > < / section > < / div > < / main > < / body > < / html >
