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

docs(readme) update links for documentation

Browse Source 
Documentation links were all broken.
This commit is contained in:
Joe Wilm 2016-01-26 20:18:49 -08:00
parent 7ace67e997
commit 1b6ae02e8a
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -13,9 +13,9 @@ the same speed as a hand written serializer for a specific type.
Documentation is available at: Documentation is available at:
* [serde](https://serde-rs.github.io/serde/serde/serde/index.html) * [serde](https://serde-rs.github.io/serde/serde/serde/serde/index.html)
* [serde\_json](https://serde-rs.github.io/serde/serde_json/serde_json/index.html) * [serde\_json](https://serde-rs.github.io/serde/serde/serde_json/serde_json/index.html)
* [serde\_codegen](https://serde-rs.github.io/serde/serde_codegen/serde_codegen/index.html) * [serde\_codegen](https://serde-rs.github.io/serde/serde/serde_codegen/serde_codegen/index.html)
Using Serde with Nightly Rust and serde\_macros Using Serde with Nightly Rust and serde\_macros
=============================================== ===============================================
@ -237,9 +237,9 @@ Serialization without Macros
Under the covers, Serde extensively uses the Visitor pattern to thread state Under the covers, Serde extensively uses the Visitor pattern to thread state
between the between the
[Serializer](http://serde-rs.github.io/serde/serde/ser/trait.Serializer.html) [Serializer](http://serde-rs.github.io/serde/serde/serde/ser/trait.Serializer.html)
and and
[Serialize](http://serde-rs.github.io/serde/serde/ser/trait.Serialize.html) [Serialize](http://serde-rs.github.io/serde/serde/serde/ser/trait.Serialize.html)
without the two having specific information about each other's concrete type. without the two having specific information about each other's concrete type.
This has many of the same benefits as frameworks that use runtime type This has many of the same benefits as frameworks that use runtime type
information without the overhead. In fact, when compiling with optimizations, information without the overhead. In fact, when compiling with optimizations,
@ -248,7 +248,7 @@ nearly as fast as a hand written serializer format for a specific type.
To see it in action, lets look at how a simple type like `i32` is serialized. To see it in action, lets look at how a simple type like `i32` is serialized.
The The
[Serializer](http://serde-rs.github.io/serde/serde/ser/trait.Serializer.html) [Serializer](http://serde-rs.github.io/serde/serde/serde/ser/trait.Serializer.html)
is threaded through the type: is threaded through the type:
```rust ```rust
@ -263,9 +263,9 @@ impl serde::Serialize for i32 {
As you can see it's pretty simple. More complex types like `BTreeMap` need to As you can see it's pretty simple. More complex types like `BTreeMap` need to
pass a pass a
[MapVisitor](http://serde-rs.github.io/serde/serde/ser/trait.MapVisitor.html) [MapVisitor](http://serde-rs.github.io/serde/serde/serde/ser/trait.MapVisitor.html)
to the to the
[Serializer](http://serde-rs.github.io/serde/serde/ser/trait.Serializer.html) [Serializer](http://serde-rs.github.io/serde/serde/serde/ser/trait.Serializer.html)
in order to walk through the type: in order to walk through the type:
```rust ```rust
@ -377,11 +377,11 @@ Deserialization without Macros
Deserialization is a little more complicated since there's a bit more error Deserialization is a little more complicated since there's a bit more error
handling that needs to occur. Let's start with the simple `i32` handling that needs to occur. Let's start with the simple `i32`
[Deserialize](http://serde-rs.github.io/serde/serde/de/trait.Deserialize.html) [Deserialize](http://serde-rs.github.io/serde/serde/serde/de/trait.Deserialize.html)
implementation. It passes a implementation. It passes a
[Visitor](http://serde-rs.github.io/serde/serde/de/trait.Visitor.html) to the [Visitor](http://serde-rs.github.io/serde/serde/serde/de/trait.Visitor.html) to the
[Deserializer](http://serde-rs.github.io/serde/serde/de/trait.Deserializer.html). [Deserializer](http://serde-rs.github.io/serde/serde/serde/de/trait.Deserializer.html).
The [Visitor](http://serde-rs.github.io/serde/serde/de/trait.Visitor.html) The [Visitor](http://serde-rs.github.io/serde/serde/serde/de/trait.Visitor.html)
can create the `i32` from a variety of different types: can create the `i32` from a variety of different types:
```rust ```rust
@ -416,9 +416,9 @@ impl serde::de::Visitor for I32Visitor {
Since it's possible for this type to get passed an unexpected type, we need a Since it's possible for this type to get passed an unexpected type, we need a
way to error out. This is done by way of the way to error out. This is done by way of the
[Error](http://serde-rs.github.io/serde/serde/de/trait.Error.html) trait, [Error](http://serde-rs.github.io/serde/serde/serde/de/trait.Error.html) trait,
which allows a which allows a
[Deserialize](http://serde-rs.github.io/serde/serde/de/trait.Deserialize.html) [Deserialize](http://serde-rs.github.io/serde/serde/serde/de/trait.Deserialize.html)
to generate an error for a few common error conditions. Here's how it could be used: to generate an error for a few common error conditions. Here's how it could be used:
```rust ```rust
@ -435,9 +435,9 @@ to generate an error for a few common error conditions. Here's how it could be u
``` ```
Maps follow a similar pattern as before, and use a Maps follow a similar pattern as before, and use a
[MapVisitor](http://serde-rs.github.io/serde/serde/de/trait.MapVisitor.html) [MapVisitor](http://serde-rs.github.io/serde/serde/serde/de/trait.MapVisitor.html)
to walk through the values generated by the to walk through the values generated by the
[Deserializer](http://serde-rs.github.io/serde/serde/de/trait.Deserializer.html). [Deserializer](http://serde-rs.github.io/serde/serde/serde/de/trait.Deserializer.html).
```rust ```rust
impl<K, V> serde::Deserialize for BTreeMap<K, V> impl<K, V> serde::Deserialize for BTreeMap<K, V>