From d04ba007dce75cd7dc39d1da9a98244e647b4303 Mon Sep 17 00:00:00 2001 From: Ty Overby Date: Wed, 11 Oct 2017 09:53:45 -0700 Subject: [PATCH] remove references to old type (#210) --- src/internal.rs | 5 +---- src/lib.rs | 4 ++-- 2 files changed, 3 insertions(+), 6 deletions(-) diff --git a/src/internal.rs b/src/internal.rs index 0297e59..89af172 100644 --- a/src/internal.rs +++ b/src/internal.rs @@ -23,9 +23,6 @@ use serde_crate as serde; pub type Result = result::Result; /// An error that can be produced during (de)serializing. -/// -/// If decoding from a Buffer, assume that the buffer has been left -/// in an invalid state. pub type Error = Box; /// The kind of error that can be produced during a serialization or deserialization. @@ -203,7 +200,7 @@ pub fn serialized_size_bounded(value: &T, max: u64) -> Option } } -/// Deserializes an object directly from a `Buffer`ed Reader. +/// Deserializes an object directly from a `Read`er. /// /// If the provided `SizeLimit` is reached, the deserialization will bail immediately. /// A SizeLimit can help prevent an attacker from flooding your server with diff --git a/src/lib.rs b/src/lib.rs index c383bc6..2c805ed 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -5,8 +5,8 @@ //! //! There are simple functions for encoding to `Vec` and decoding from //! `&[u8]`, but the meat of the library is the `serialize_into` and `deserialize_from` -//! functions which respectively allow encoding into a `std::io::Writer` -//! and decoding from a `std::io::Buffer`. +//! functions which respectively allow encoding into any `std::io::Write` +//! or decode from any `std::io::Read`. //! //! ## Modules //! Until "default type parameters" lands, we have an extra module called `endian_choice`