From 94bba496747209d3a27bba110e8301400eb2258e Mon Sep 17 00:00:00 2001
From: Darien Raymond <admin@v2ray.com>
Date: Mon, 23 Oct 2017 14:15:16 +0200
Subject: [PATCH] fix lint warnings

---
 transport/ray/direct.go | 14 ++++++++++++--
 1 file changed, 12 insertions(+), 2 deletions(-)

diff --git a/transport/ray/direct.go b/transport/ray/direct.go
index e26348c2..34a01fc8 100644
--- a/transport/ray/direct.go
+++ b/transport/ray/direct.go
@@ -6,6 +6,7 @@ import (
 	"sync"
 	"time"
 
+	"v2ray.com/core/common"
 	"v2ray.com/core/common/buf"
 	"v2ray.com/core/common/platform"
 )
@@ -50,6 +51,7 @@ func init() {
 	streamSizeLimit = uint64(size) * 1024 * 1024
 }
 
+// Stream is a sequential container for data in bytes.
 type Stream struct {
 	access      sync.RWMutex
 	data        buf.MultiBuffer
@@ -61,6 +63,7 @@ type Stream struct {
 	err         bool
 }
 
+// NewStream creates a new Stream.
 func NewStream(ctx context.Context) *Stream {
 	return &Stream{
 		ctx:         ctx,
@@ -92,15 +95,17 @@ func (s *Stream) getData() (buf.MultiBuffer, error) {
 	return nil, nil
 }
 
+// Peek fills in the given buffer with data from head of the Stream.
 func (s *Stream) Peek(b *buf.Buffer) {
 	s.access.RLock()
 	defer s.access.RUnlock()
 
-	b.Reset(func(data []byte) (int, error) {
+	common.Must(b.Reset(func(data []byte) (int, error) {
 		return s.data.Copy(data), nil
-	})
+	}))
 }
 
+// Read reads data from the Stream.
 func (s *Stream) Read() (buf.MultiBuffer, error) {
 	for {
 		mb, err := s.getData()
@@ -121,6 +126,7 @@ func (s *Stream) Read() (buf.MultiBuffer, error) {
 	}
 }
 
+// ReadTimeout reads from the Stream with a specified timeout.
 func (s *Stream) ReadTimeout(timeout time.Duration) (buf.MultiBuffer, error) {
 	for {
 		mb, err := s.getData()
@@ -151,6 +157,7 @@ func (s *Stream) Size() uint64 {
 	return s.size
 }
 
+// waitForStreamSize waits until the Stream has room for more data, or any error happens.
 func (s *Stream) waitForStreamSize() error {
 	if streamSizeLimit == 0 {
 		return nil
@@ -170,6 +177,7 @@ func (s *Stream) waitForStreamSize() error {
 	return nil
 }
 
+// Write writes more data into the Stream.
 func (s *Stream) Write(data buf.MultiBuffer) error {
 	if data.IsEmpty() {
 		return nil
@@ -213,6 +221,7 @@ func (s *Stream) notifyWrite() {
 	}
 }
 
+// Close closes the stream for writing. Read() still works until EOF.
 func (s *Stream) Close() {
 	s.access.Lock()
 	s.close = true
@@ -221,6 +230,7 @@ func (s *Stream) Close() {
 	s.access.Unlock()
 }
 
+// CloseError closes the Stream with error. Read() will return an error afterwards.
 func (s *Stream) CloseError() {
 	s.access.Lock()
 	s.err = true