From 34aba9acbe0aaf0a0ca251e3d9cd6b634f9f08ab Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Lena=20Hellstr=C3=B6m?= <lena@stygian.nexus>
Date: Sun, 23 Jul 2017 23:57:53 -0500
Subject: [PATCH] Internal type names (#199)

* Remove internal type names from api

* Rename IoReadReader to IoReader
---
 src/de/read.rs  | 26 +++++++++++++-------------
 src/internal.rs | 11 +++++------
 src/lib.rs      |  4 ++--
 3 files changed, 20 insertions(+), 21 deletions(-)

diff --git a/src/de/read.rs b/src/de/read.rs
index 5235eb9..04f9639 100644
--- a/src/de/read.rs
+++ b/src/de/read.rs
@@ -1,10 +1,10 @@
-use std::io::{Read as IoRead, Result as IoResult, Error as IoError, ErrorKind as IoErrorKind};
+use std::io;
 use ::Result;
 use serde_crate as serde;
 
 /// A byte-oriented reading trait that is specialized for
 /// slices and generic readers.
-pub trait BincodeRead<'storage>: IoRead + ::private::Sealed {
+pub trait BincodeRead<'storage>: io::Read + ::private::Sealed {
     #[doc(hidden)]
     fn forward_read_str<V>(&mut self, length: usize, visitor: V) ->  Result<V::Value>
     where V: serde::de::Visitor<'storage>;
@@ -23,7 +23,7 @@ pub struct SliceReader<'storage> {
 }
 
 /// A BincodeRead implementation for io::Readers
-pub struct IoReadReader<R> {
+pub struct IoReader<R> {
     reader: R,
     temp_buffer: Vec<u8>,
 }
@@ -37,31 +37,31 @@ impl <'storage> SliceReader<'storage> {
     }
 }
 
-impl <R> IoReadReader<R> {
+impl <R> IoReader<R> {
     /// Constructs an IoReadReader
-    pub fn new(r: R) -> IoReadReader<R> {
-        IoReadReader {
+    pub fn new(r: R) -> IoReader<R> {
+        IoReader {
             reader: r,
             temp_buffer: vec![],
         }
     }
 }
 
-impl <'storage> IoRead for SliceReader<'storage> {
-    fn read(&mut self, out: & mut [u8]) -> IoResult<usize> {
+impl <'storage> io::Read for SliceReader<'storage> {
+    fn read(&mut self, out: & mut [u8]) -> io::Result<usize> {
         (&mut self.slice).read(out)
     }
 }
 
-impl <R: IoRead> IoRead for IoReadReader<R> {
-    fn read(&mut self, out: & mut [u8]) -> IoResult<usize> {
+impl <R: io::Read> io::Read for IoReader<R> {
+    fn read(&mut self, out: & mut [u8]) -> io::Result<usize> {
         self.reader.read(out)
     }
 }
 
 impl <'storage> SliceReader<'storage> {
     fn unexpected_eof() -> Box<::ErrorKind> {
-        return Box::new(::ErrorKind::Io(IoError::new(IoErrorKind::UnexpectedEof, "")));
+        return Box::new(::ErrorKind::Io(io::Error::new(io::ErrorKind::UnexpectedEof, "")));
     }
 }
 
@@ -107,7 +107,7 @@ impl <'storage> BincodeRead<'storage> for SliceReader<'storage> {
     }
 }
 
-impl <R> IoReadReader<R> where R: IoRead {
+impl <R> IoReader<R> where R: io::Read {
     fn fill_buffer(&mut self, length: usize) -> Result<()> {
         let current_length = self.temp_buffer.len();
         if length > current_length{
@@ -120,7 +120,7 @@ impl <R> IoReadReader<R> where R: IoRead {
     }
 }
 
-impl <R> BincodeRead<'static> for IoReadReader<R> where R: IoRead {
+impl <R> BincodeRead<'static> for IoReader<R> where R: io::Read {
     fn forward_read_str<V>(&mut self, length: usize, visitor: V) ->  Result<V::Value>
     where V: serde::de::Visitor<'static> {
         self.fill_buffer(length)?;
diff --git a/src/internal.rs b/src/internal.rs
index 565e3ab..b0efe05 100644
--- a/src/internal.rs
+++ b/src/internal.rs
@@ -2,8 +2,7 @@
 //! that use the `serde` crate for the serializable and deserializable
 //! implementation.
 
-use std::io::{Write, Read};
-use std::io::Error as IoError;
+use std::io::{self, Write, Read};
 use std::{error, fmt, result};
 use ::{CountSize, SizeLimit};
 use byteorder::{ByteOrder};
@@ -34,7 +33,7 @@ pub type Error = Box<ErrorKind>;
 pub enum ErrorKind {
     /// If the error stems from the reader/writer that is being used
     /// during (de)serialization, that error will be stored and returned here.
-    Io(IoError),
+    Io(io::Error),
     /// If the bytes in the reader are not decodable because of an invalid
     /// encoding, this error will be returned.  This error is only possible
     /// if a stream is corrupted.  A stream produced from `encode` or `encode_into`
@@ -77,8 +76,8 @@ impl error::Error for ErrorKind {
     }
 }
 
-impl From<IoError> for Error {
-    fn from(err: IoError) -> Error {
+impl From<io::Error> for Error {
+    fn from(err: io::Error) -> Error {
         ErrorKind::Io(err).into()
     }
 }
@@ -216,7 +215,7 @@ pub fn serialized_size_bounded<T: ?Sized>(value: &T, max: u64) -> Option<u64>
 pub fn deserialize_from<R: ?Sized, T, S, E>(reader: &mut R, size_limit: S) -> Result<T>
     where R: Read, T: serde::de::DeserializeOwned, S: SizeLimit, E: ByteOrder
 {
-    let reader = ::de::read::IoReadReader::new(reader);
+    let reader = ::de::read::IoReader::new(reader);
     let mut deserializer = Deserializer::<_, S, E>::new(reader, size_limit);
     serde::Deserialize::deserialize(&mut deserializer)
 }
diff --git a/src/lib.rs b/src/lib.rs
index d825f13..364b380 100644
--- a/src/lib.rs
+++ b/src/lib.rs
@@ -46,7 +46,7 @@ pub mod internal;
 
 pub mod read_types {
     //! The types that the deserializer uses for optimizations
-    pub use ::de::read::{SliceReader, BincodeRead, IoReadReader};
+    pub use ::de::read::{SliceReader, BincodeRead, IoReader};
 }
 
 use std::io::{Read, Write};
@@ -175,7 +175,7 @@ mod private {
     pub trait Sealed {}
 
     impl<'a> Sealed for super::de::read::SliceReader<'a> {}
-    impl<R> Sealed for super::de::read::IoReadReader<R> {}
+    impl<R> Sealed for super::de::read::IoReader<R> {}
     impl Sealed for super::Infinite {}
     impl Sealed for super::Bounded {}
     impl Sealed for super::CountSize {}