itsscb/serde
1
0
Fork 0
mirror of https://github.com/serde-rs/serde.git synced 2025-10-02 23:35:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Hyperlink the de module documentation

Browse Source
This commit is contained in:
David Tolnay 2017-04-13 17:43:10 -07:00
parent 3f920f645c
commit 37f8ea234f
No known key found for this signature in database
GPG Key ID: F9BA143B95FF6D82
1 changed files with 28 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -8,8 +8,8 @@
//! Generic data structure deserialization framework. //! Generic data structure deserialization framework.
//! //!
//! The two most important traits in this module are `Deserialize` and //! The two most important traits in this module are [`Deserialize`] and
//! `Deserializer`. //! [`Deserializer`].
//! //!
//! - **A type that implements `Deserialize` is a data structure** that can be //! - **A type that implements `Deserialize` is a data structure** that can be
//! deserialized from any data format supported by Serde, and conversely //! deserialized from any data format supported by Serde, and conversely
@ -18,32 +18,31 @@
//! //!
//! # The Deserialize trait //! # The Deserialize trait
//! //!
//! Serde provides `Deserialize` implementations for many Rust primitive and //! Serde provides [`Deserialize`] implementations for many Rust primitive and
//! standard library types. The complete list is below. All of these can be //! standard library types. The complete list is below. All of these can be
//! deserialized using Serde out of the box. //! deserialized using Serde out of the box.
//! //!
//! Additionally, Serde provides a procedural macro called `serde_derive` to //! Additionally, Serde provides a procedural macro called [`serde_derive`] to
//! automatically generate `Deserialize` implementations for structs and enums //! automatically generate [`Deserialize`] implementations for structs and enums
//! in your program. See the [codegen section of the manual][codegen] for how to //! in your program. See the [codegen section of the manual] for how to use
//! use this. //! this.
//! //!
//! In rare cases it may be necessary to implement `Deserialize` manually for //! In rare cases it may be necessary to implement [`Deserialize`] manually for
//! some type in your program. See the [Implementing //! some type in your program. See the [Implementing `Deserialize`] section of
//! `Deserialize`][impl-deserialize] section of the manual for more about this. //! the manual for more about this.
//! //!
//! Third-party crates may provide `Deserialize` implementations for types that //! Third-party crates may provide [`Deserialize`] implementations for types
//! they expose. For example the `linked-hash-map` crate provides a //! that they expose. For example the [`linked-hash-map`] crate provides a
//! `LinkedHashMap<K, V>` type that is deserializable by Serde because the crate //! [`LinkedHashMap<K, V>`] type that is deserializable by Serde because the
//! provides an implementation of `Deserialize` for it. //! crate provides an implementation of [`Deserialize`] for it.
//! //!
//! # The Deserializer trait //! # The Deserializer trait
//! //!
//! `Deserializer` implementations are provided by third-party crates, for //! [`Deserializer`] implementations are provided by third-party crates, for
//! example [`serde_json`][serde_json], [`serde_yaml`][serde_yaml] and //! example [`serde_json`], [`serde_yaml`] and [`bincode`].
//! [`bincode`][bincode].
//! //!
//! A partial list of well-maintained formats is given on the [Serde //! A partial list of well-maintained formats is given on the [Serde
//! website][data-formats]. //! website][data formats].
//! //!
//! # Implementations of Deserialize provided by Serde //! # Implementations of Deserialize provided by Serde
//! //!
@ -95,12 +94,17 @@
//! - SocketAddrV4 //! - SocketAddrV4
//! - SocketAddrV6 //! - SocketAddrV6
//! //!
//! [codegen]: https://serde.rs/codegen.html //! [Implementing `Deserialize`]: https://serde.rs/impl-deserialize.html
//! [impl-deserialize]: https://serde.rs/impl-deserialize.html //! [`Deserialize`]: ../trait.Deserialize.html
//! [serde_json]: https://github.com/serde-rs/json //! [`Deserializer`]: ../trait.Deserializer.html
//! [serde_yaml]: https://github.com/dtolnay/serde-yaml //! [`LinkedHashMap<K, V>`]: https://docs.rs/linked-hash-map/*/linked_hash_map/struct.LinkedHashMap.html
//! [bincode]: https://github.com/TyOverby/bincode //! [`bincode`]: https://github.com/TyOverby/bincode
//! [data-formats]: https://serde.rs/#data-formats //! [`linked-hash-map`]: https://crates.io/crates/linked-hash-map
//! [`serde_derive`]: https://crates.io/crates/serde_derive
//! [`serde_json`]: https://github.com/serde-rs/json
//! [`serde_yaml`]: https://github.com/dtolnay/serde-yaml
//! [codegen section of the manual]: https://serde.rs/codegen.html
//! [data formats]: https://serde.rs/#data-formats
use lib::*; use lib::*;