From 1c6ddfd34cabb67377868ca03524abc6087af59a Mon Sep 17 00:00:00 2001
From: Nikolay Kim <fafhrd91@gmail.com>
Date: Fri, 9 Mar 2018 05:36:40 -0800
Subject: [PATCH] naming

---
 src/multipart.rs |  6 +++---
 src/payload.rs   | 10 +++++-----
 src/ws/frame.rs  |  4 +++-
 3 files changed, 11 insertions(+), 9 deletions(-)

diff --git a/src/multipart.rs b/src/multipart.rs
index 898a7f194..45126a2a6 100644
--- a/src/multipart.rs
+++ b/src/multipart.rs
@@ -130,7 +130,7 @@ impl<S> InnerMultipart<S> where S: Stream<Item=Bytes, Error=PayloadError> {
 
     fn read_headers(payload: &mut PayloadHelper<S>) -> Poll<HeaderMap, MultipartError>
     {
-        match payload.readuntil(b"\r\n\r\n")? {
+        match payload.read_until(b"\r\n\r\n")? {
             Async::NotReady => Ok(Async::NotReady),
             Async::Ready(None) => Err(MultipartError::Incomplete),
             Async::Ready(Some(bytes)) => {
@@ -469,13 +469,13 @@ impl<S> InnerField<S> where S: Stream<Item=Bytes, Error=PayloadError> {
     fn read_stream(payload: &mut PayloadHelper<S>, boundary: &str)
                    -> Poll<Option<Bytes>, MultipartError>
     {
-        match payload.readuntil(b"\r")? {
+        match payload.read_until(b"\r")? {
             Async::NotReady => Ok(Async::NotReady),
             Async::Ready(None) => Err(MultipartError::Incomplete),
             Async::Ready(Some(mut chunk)) => {
                 if chunk.len() == 1 {
                     payload.unread_data(chunk);
-                    match payload.readexactly(boundary.len() + 4)? {
+                    match payload.read_exact(boundary.len() + 4)? {
                         Async::NotReady => Ok(Async::NotReady),
                         Async::Ready(None) => Err(MultipartError::Incomplete),
                         Async::Ready(Some(chunk)) => {
diff --git a/src/payload.rs b/src/payload.rs
index 512d56f1e..d32e85a4f 100644
--- a/src/payload.rs
+++ b/src/payload.rs
@@ -313,7 +313,7 @@ impl<S> PayloadHelper<S> where S: Stream<Item=Bytes, Error=PayloadError> {
     }
 
     #[inline]
-    pub fn readexactly(&mut self, size: usize) -> Poll<Option<Bytes>, PayloadError> {
+    pub fn read_exact(&mut self, size: usize) -> Poll<Option<Bytes>, PayloadError> {
         if size <= self.len {
             self.len -= size;
             let mut chunk = self.items.pop_front().unwrap();
@@ -341,7 +341,7 @@ impl<S> PayloadHelper<S> where S: Stream<Item=Bytes, Error=PayloadError> {
             }
         } else {
             match self.poll_stream()? {
-                Async::Ready(true) => self.readexactly(size),
+                Async::Ready(true) => self.read_exact(size),
                 Async::Ready(false) => Ok(Async::Ready(None)),
                 Async::NotReady => Ok(Async::NotReady),
             }
@@ -387,7 +387,7 @@ impl<S> PayloadHelper<S> where S: Stream<Item=Bytes, Error=PayloadError> {
         }
     }
 
-    pub fn readuntil(&mut self, line: &[u8]) -> Poll<Option<Bytes>, PayloadError> {
+    pub fn read_until(&mut self, line: &[u8]) -> Poll<Option<Bytes>, PayloadError> {
         let mut idx = 0;
         let mut num = 0;
         let mut offset = 0;
@@ -436,14 +436,14 @@ impl<S> PayloadHelper<S> where S: Stream<Item=Bytes, Error=PayloadError> {
         }
 
         match self.poll_stream()? {
-            Async::Ready(true) => self.readuntil(line),
+            Async::Ready(true) => self.read_until(line),
             Async::Ready(false) => Ok(Async::Ready(None)),
             Async::NotReady => Ok(Async::NotReady),
         }
     }
 
     pub fn readline(&mut self) -> Poll<Option<Bytes>, PayloadError> {
-        self.readuntil(b"\n")
+        self.read_until(b"\n")
     }
 
     pub fn unread_data(&mut self, data: Bytes) {
diff --git a/src/ws/frame.rs b/src/ws/frame.rs
index 52a20e50a..c17437979 100644
--- a/src/ws/frame.rs
+++ b/src/ws/frame.rs
@@ -198,6 +198,7 @@ impl Frame {
                     -> Poll<Option<Frame>, ProtocolError>
         where S: Stream<Item=Bytes, Error=PayloadError>
     {
+        // try to parse ws frame md from one chunk
         let result = match pl.get_chunk()? {
             Async::NotReady => return Ok(Async::NotReady),
             Async::Ready(Some(chunk)) => Frame::read_chunk_md(chunk, server, max_size)?,
@@ -205,6 +206,7 @@ impl Frame {
         };
 
         let (idx, finished, opcode, length, mask) = match result {
+            // we may need to join several chunks
             Async::NotReady => match Frame::read_copy_md(pl, server, max_size)? {
                 Async::NotReady => return Ok(Async::NotReady),
                 Async::Ready(Some(item)) => item,
@@ -228,7 +230,7 @@ impl Frame {
                 finished, opcode, payload: Binary::from("") })));
         }
 
-        let data = match pl.readexactly(length)? {
+        let data = match pl.read_exact(length)? {
             Async::Ready(Some(buf)) => buf,
             Async::Ready(None) => return Ok(Async::Ready(None)),
             Async::NotReady => panic!(),