itsscb/serde
1
0
Fork 0
mirror of https://github.com/serde-rs/serde.git synced 2025-09-29 14:02:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2714 from Marcono1234/skipped-field-struct-len

Browse Source 
Document that `len` does not include skipped struct fields
This commit is contained in:
David Tolnay 2024-03-16 12:49:50 -07:00 committed by GitHub
commit 9f8c579bf5
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 8 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
serde/src/ser/mod.rs
View File

@ -1170,7 +1170,8 @@ pub trait Serializer: Sized {
/// then a call to `end`. /// then a call to `end`.
/// ///
/// The `name` is the name of the struct and the `len` is the number of /// The `name` is the name of the struct and the `len` is the number of
/// data fields that will be serialized. /// data fields that will be serialized. `len` does not include fields
/// which are skipped with [`SerializeStruct::skip_field`].
/// ///
/// ```edition2021 /// ```edition2021
/// use serde::ser::{Serialize, SerializeStruct, Serializer}; /// use serde::ser::{Serialize, SerializeStruct, Serializer};
@ -1207,6 +1208,8 @@ pub trait Serializer: Sized {
/// The `name` is the name of the enum, the `variant_index` is the index of /// The `name` is the name of the enum, the `variant_index` is the index of
/// this variant within the enum, the `variant` is the name of the variant, /// this variant within the enum, the `variant` is the name of the variant,
/// and the `len` is the number of data fields that will be serialized. /// and the `len` is the number of data fields that will be serialized.
/// `len` does not include fields which are skipped with
/// [`SerializeStructVariant::skip_field`].
/// ///
/// ```edition2021 /// ```edition2021
/// use serde::ser::{Serialize, SerializeStructVariant, Serializer}; /// use serde::ser::{Serialize, SerializeStructVariant, Serializer};
@ -1857,6 +1860,8 @@ pub trait SerializeStruct {
T: ?Sized + Serialize; T: ?Sized + Serialize;
/// Indicate that a struct field has been skipped. /// Indicate that a struct field has been skipped.
///
/// The default implementation does nothing.
#[inline] #[inline]
fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error> { fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error> {
let _ = key; let _ = key;
@ -1919,6 +1924,8 @@ pub trait SerializeStructVariant {
T: ?Sized + Serialize; T: ?Sized + Serialize;
/// Indicate that a struct variant field has been skipped. /// Indicate that a struct variant field has been skipped.
///
/// The default implementation does nothing.
#[inline] #[inline]
fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error> { fn skip_field(&mut self, key: &'static str) -> Result<(), Self::Error> {
let _ = key; let _ = key;