mikros/serde
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update serde documentation to 2018 edition

Browse Source
This commit is contained in:
David Tolnay 2018-12-31 22:59:55 -05:00
parent f1f8386f2e
commit 054ab1adaf
No known key found for this signature in database
GPG Key ID: F9BA143B95FF6D82
8 changed files with 33 additions and 108 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
.travis.yml
View File

@ -25,7 +25,7 @@ matrix:
- cargo build --no-default-features
- cargo build --no-default-features --features alloc
- cargo build --no-default-features --features rc,alloc
- cargo test --features rc,unstable
- cargo test --features rc,unstable,derive
- cd "${TRAVIS_BUILD_DIR}/test_suite/deps"
- cargo build
- cd "${TRAVIS_BUILD_DIR}/test_suite"

10
serde/src/de/mod.rs
View File

@ -173,7 +173,7 @@ macro_rules! declare_error_trait {
/// where
/// D: Deserializer<'de>,
/// {
/// let s = try!(String::deserialize(deserializer));
/// let s = String::deserialize(deserializer)?;
/// s.parse().map_err(de::Error::custom)
/// }
/// }
@ -2208,13 +2208,9 @@ pub trait VariantAccess<'de>: Sized {
/// # Example
///
/// ```rust
/// #[macro_use]
/// extern crate serde_derive;
///
/// extern crate serde;
///
/// use std::str::FromStr;
/// use serde::de::{value, Deserialize, IntoDeserializer};
/// use serde::Deserialize;
/// use serde::de::{value, IntoDeserializer};
///
/// #[derive(Deserialize)]
/// enum Setting {

8
serde/src/de/value.rs
View File

@ -2,13 +2,9 @@
//! trait.
//!
//! ```rust
//! #[macro_use]
//! extern crate serde_derive;
//!
//! extern crate serde;
//!
//! use std::str::FromStr;
//! use serde::de::{value, Deserialize, IntoDeserializer};
//! use serde::Deserialize;
//! use serde::de::{value, IntoDeserializer};
//!
//! #[derive(Deserialize)]
//! enum Setting {

8
serde/src/integer128.rs
View File

@ -10,13 +10,11 @@
/// integers.
///
/// ```rust
/// #[macro_use]
/// extern crate serde;
///
/// use serde::Serializer;
/// # use serde::private::ser::Error;
/// #
/// # struct MySerializer;
/// #
/// use serde::{serde_if_integer128, Serializer};
///
/// impl Serializer for MySerializer {
/// type Ok = ();
@ -41,7 +39,7 @@
/// }
/// }
/// #
/// # __serialize_unimplemented! {
/// # serde::__serialize_unimplemented! {
/// # bool i8 i16 i32 u8 u16 u32 u64 f32 f64 char str bytes none some
/// # unit unit_struct unit_variant newtype_struct newtype_variant seq
/// # tuple tuple_struct tuple_variant map struct struct_variant

12
serde/src/macros.rs
View File

@ -12,9 +12,7 @@
/// trait methods.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::forward_to_deserialize_any;
/// # use serde::de::{value, Deserializer, Visitor};
/// #
/// # struct MyDeserializer;
@ -52,9 +50,7 @@
/// You can choose which methods to forward.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::forward_to_deserialize_any;
/// # use serde::de::{value, Deserializer, Visitor};
/// #
/// # struct MyDeserializer;
@ -87,11 +83,9 @@
/// specified explicitly if necessary.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use std::marker::PhantomData;
/// #
/// # use serde::forward_to_deserialize_any;
/// # use serde::de::{value, Deserializer, Visitor};
/// #
/// # struct MyDeserializer<V>(PhantomData<V>);

5
serde/src/ser/impossible.rs
View File

@ -16,9 +16,6 @@ use ser::{
/// [`SerializeMap`], [`SerializeStruct`], and [`SerializeStructVariant`].
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::ser::{Serializer, Impossible};
/// # use serde::private::ser::Error;
/// #
@ -44,7 +41,7 @@ use ser::{
/// }
///
/// /* other Serializer methods */
/// # __serialize_unimplemented! {
/// # serde::__serialize_unimplemented! {
/// # bool i8 i16 i32 i64 u8 u16 u32 u64 f32 f64 char str bytes none some
/// # unit unit_struct unit_variant newtype_struct newtype_variant
/// # tuple tuple_struct tuple_variant map struct struct_variant

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

@ -378,12 +378,9 @@ pub trait Serializer: Sized {
/// Serialize a `bool` value.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for bool {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -405,12 +402,9 @@ pub trait Serializer: Sized {
/// forward to `serialize_i64`.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for i8 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -432,12 +426,9 @@ pub trait Serializer: Sized {
/// forward to `serialize_i64`.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for i16 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -459,12 +450,9 @@ pub trait Serializer: Sized {
/// forward to `serialize_i64`.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for i32 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -482,12 +470,9 @@ pub trait Serializer: Sized {
/// Serialize an `i64` value.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for i64 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -506,12 +491,9 @@ pub trait Serializer: Sized {
/// Serialize an `i128` value.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for i128 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -540,12 +522,9 @@ pub trait Serializer: Sized {
/// forward to `serialize_u64`.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for u8 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -567,12 +546,9 @@ pub trait Serializer: Sized {
/// forward to `serialize_u64`.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for u16 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -594,12 +570,9 @@ pub trait Serializer: Sized {
/// forward to `serialize_u64`.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for u32 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -617,12 +590,9 @@ pub trait Serializer: Sized {
/// Serialize a `u64` value.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for u64 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -641,12 +611,9 @@ pub trait Serializer: Sized {
/// Serialize a `u128` value.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for u128 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -675,12 +642,9 @@ pub trait Serializer: Sized {
/// forward to `serialize_f64`.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for f32 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -698,12 +662,9 @@ pub trait Serializer: Sized {
/// Serialize an `f64` value.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for f64 {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -724,12 +685,9 @@ pub trait Serializer: Sized {
/// it as a single element `str` or a `u32`.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for char {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -747,12 +705,9 @@ pub trait Serializer: Sized {
/// Serialize a `&str`.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for str {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
@ -776,9 +731,6 @@ pub trait Serializer: Sized {
/// like this:
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::ser::{Serializer, SerializeSeq};
/// # use serde::private::ser::Error;
/// #
@ -796,7 +748,7 @@ pub trait Serializer: Sized {
/// seq.end()
/// }
/// #
/// # __serialize_unimplemented! {
/// # serde::__serialize_unimplemented! {
/// # bool i8 i16 i32 i64 u8 u16 u32 u64 f32 f64 char str none some
/// # unit unit_struct unit_variant newtype_struct newtype_variant
/// # seq tuple tuple_struct tuple_variant map struct struct_variant
@ -810,8 +762,6 @@ pub trait Serializer: Sized {
/// Serialize a [`None`] value.
///
/// ```rust
/// # extern crate serde;
/// #
/// # use serde::{Serialize, Serializer};
/// #
/// # enum Option<T> {
@ -819,7 +769,7 @@ pub trait Serializer: Sized {
/// # None,
/// # }
/// #
/// # use Option::{Some, None};
/// # use self::Option::{Some, None};
/// #
/// impl<T> Serialize for Option<T>
/// where
@ -845,8 +795,6 @@ pub trait Serializer: Sized {
/// Serialize a [`Some(T)`] value.
///
/// ```rust
/// # extern crate serde;
/// #
/// # use serde::{Serialize, Serializer};
/// #
/// # enum Option<T> {
@ -854,7 +802,7 @@ pub trait Serializer: Sized {
/// # None,
/// # }
/// #
/// # use Option::{Some, None};
/// # use self::Option::{Some, None};
/// #
/// impl<T> Serialize for Option<T>
/// where
@ -882,12 +830,9 @@ pub trait Serializer: Sized {
/// Serialize a `()` value.
///
/// ```rust
/// # #[macro_use]
/// # extern crate serde;
/// #
/// # use serde::Serializer;
/// #
/// # __private_serialize!();
/// # serde::__private_serialize!();
/// #
/// impl Serialize for () {
/// fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

3
serde_derive/src/lib.rs
View File

@ -1,8 +1,7 @@
//! This crate provides Serde's two derive macros.
//!
//! ```rust
//! # #[macro_use]
//! # extern crate serde_derive;
//! # use serde_derive::{Serialize, Deserialize};
//! #
//! #[derive(Serialize, Deserialize)]
//! # struct S;