merge bufio into buf

common/buf/buffer.go

@@ -175,17 +175,17 @@ func (b *Buffer) String() string {
 	return string(b.Bytes())
 }
 
-// New creates a Buffer with 8K bytes of arbitrary content.
+// New creates a Buffer with 0 length and 8K capacity.
 func New() *Buffer {
 	return mediumPool.Allocate()
 }
 
-// NewSmall returns a buffer with 2K bytes capacity.
+// NewSmall returns a buffer with 0 length and 2K capacity.
 func NewSmall() *Buffer {
 	return smallPool.Allocate()
 }
 
-// NewLocal creates and returns a buffer on current thread.
+// NewLocal creates and returns a buffer with 0 length and given capacity on current thread.
 func NewLocal(size int) *Buffer {
 	return &Buffer{
 		v:    make([]byte, size),

common/buf/buffered_reader.go

@@ -1,23 +1,21 @@
-package bufio
+package buf
 
 import (
 	"io"
-
-	"v2ray.com/core/common/buf"
 )
 
 // BufferedReader is a reader with internal cache.
 type BufferedReader struct {
 	reader   io.Reader
-	buffer   *buf.Buffer
+	buffer   *Buffer
 	buffered bool
 }
 
 // NewReader creates a new BufferedReader based on an io.Reader.
-func NewReader(rawReader io.Reader) *BufferedReader {
+func NewBufferedReader(rawReader io.Reader) *BufferedReader {
 	return &BufferedReader{
 		reader:   rawReader,
-		buffer:   buf.NewLocal(1024),
+		buffer:   NewLocal(1024),
 		buffered: true,
 	}
 }
@@ -42,7 +40,7 @@ func (v *BufferedReader) Read(b []byte) (int, error) {
 		return v.reader.Read(b)
 	}
 	if v.buffer.IsEmpty() {
-		err := v.buffer.AppendSupplier(buf.ReadFrom(v.reader))
+		err := v.buffer.AppendSupplier(ReadFrom(v.reader))
 		if err != nil {
 			return 0, err
 		}

common/buf/buffered_reader_test.go

@@ -1,23 +1,22 @@
-package bufio_test
+package buf_test
 
 import (
 	"crypto/rand"
 	"testing"
 
-	"v2ray.com/core/common/buf"
-	. "v2ray.com/core/common/bufio"
+	. "v2ray.com/core/common/buf"
 	"v2ray.com/core/testing/assert"
 )
 
 func TestBufferedReader(t *testing.T) {
 	assert := assert.On(t)
 
-	content := buf.New()
-	assert.Error(content.AppendSupplier(buf.ReadFrom(rand.Reader))).IsNil()
+	content := New()
+	assert.Error(content.AppendSupplier(ReadFrom(rand.Reader))).IsNil()
 
 	len := content.Len()
 
-	reader := NewReader(content)
+	reader := NewBufferedReader(content)
 	assert.Bool(reader.IsBuffered()).IsTrue()
 
 	payload := make([]byte, 16)

common/buf/buffered_writer.go

@@ -1,9 +1,8 @@
-package bufio
+package buf
 
 import (
 	"io"
 
-	"v2ray.com/core/common/buf"
 	"v2ray.com/core/common/errors"
 )
 
@@ -11,15 +10,15 @@ import (
 // This type is not thread safe.
 type BufferedWriter struct {
 	writer   io.Writer
-	buffer   *buf.Buffer
+	buffer   *Buffer
 	buffered bool
 }
 
 // NewWriter creates a new BufferedWriter.
-func NewWriter(rawWriter io.Writer) *BufferedWriter {
+func NewBufferedWriter(rawWriter io.Writer) *BufferedWriter {
 	return &BufferedWriter{
 		writer:   rawWriter,
-		buffer:   buf.NewLocal(1024),
+		buffer:   NewLocal(1024),
 		buffered: true,
 	}
 }
@@ -29,7 +28,7 @@ func (v *BufferedWriter) ReadFrom(reader io.Reader) (int64, error) {
 	totalBytes := int64(0)
 	for {
 		oriSize := v.buffer.Len()
-		err := v.buffer.AppendSupplier(buf.ReadFrom(reader))
+		err := v.buffer.AppendSupplier(ReadFrom(reader))
 		totalBytes += int64(v.buffer.Len() - oriSize)
 		if err != nil {
 			if errors.Cause(err) == io.EOF {

common/buf/buffered_writer_test.go

@@ -1,20 +1,19 @@
-package bufio_test
+package buf_test
 
 import (
 	"crypto/rand"
 	"testing"
 
-	"v2ray.com/core/common/buf"
-	. "v2ray.com/core/common/bufio"
+	. "v2ray.com/core/common/buf"
 	"v2ray.com/core/testing/assert"
 )
 
 func TestBufferedWriter(t *testing.T) {
 	assert := assert.On(t)
 
-	content := buf.New()
+	content := New()
 
-	writer := NewWriter(content)
+	writer := NewBufferedWriter(content)
 	assert.Bool(writer.IsBuffered()).IsTrue()
 
 	payload := make([]byte, 16)
@@ -32,9 +31,9 @@ func TestBufferedWriter(t *testing.T) {
 func TestBufferedWriterLargePayload(t *testing.T) {
 	assert := assert.On(t)
 
-	content := buf.NewLocal(128 * 1024)
+	content := NewLocal(128 * 1024)
 
-	writer := NewWriter(content)
+	writer := NewBufferedWriter(content)
 	assert.Bool(writer.IsBuffered()).IsTrue()
 
 	payload := make([]byte, 64*1024)

common/buf/io.go

@@ -33,7 +33,8 @@ func ReadFullFrom(reader io.Reader, size int) Supplier {
 	}
 }
 
-// Pipe dumps all content from reader to writer, until an error happens.
+// Pipe dumps all payload from reader to writer, until an error occurs.
+// ActivityTimer gets updated as soon as there is a payload.
 func Pipe(timer *signal.ActivityTimer, reader Reader, writer Writer) error {
 	for {
 		buffer, err := reader.Read()
@@ -73,7 +74,8 @@ func NewReader(reader io.Reader) Reader {
 	}
 }
 
-func NewBytesReader(stream Reader) *BufferToBytesReader {
+// ToBytesReader converts a Reaaer to io.Reader.
+func ToBytesReader(stream Reader) io.Reader {
 	return &BufferToBytesReader{
 		stream: stream,
 	}
@@ -86,7 +88,8 @@ func NewWriter(writer io.Writer) Writer {
 	}
 }
 
-func NewBytesWriter(writer Writer) *BytesToBufferWriter {
+// ToBytesWriter converts a Writer to io.Writer
+func ToBytesWriter(writer Writer) io.Writer {
 	return &BytesToBufferWriter{
 		writer: writer,
 	}

common/buf/writer_test.go

@@ -6,7 +6,6 @@ import (
 	"testing"
 
 	. "v2ray.com/core/common/buf"
-	"v2ray.com/core/common/bufio"
 	"v2ray.com/core/testing/assert"
 )
 
@@ -20,7 +19,7 @@ func TestWriter(t *testing.T) {
 
 	writeBuffer := bytes.NewBuffer(make([]byte, 0, 1024*1024))
 
-	writer := NewWriter(bufio.NewWriter(writeBuffer))
+	writer := NewWriter(NewBufferedWriter(writeBuffer))
 	err := writer.Write(lb)
 	assert.Error(err).IsNil()
 	assert.Bytes(expectedBytes).Equals(writeBuffer.Bytes())

common/bufio/bufio.go

@@ -1,17 +0,0 @@
-// Package bufio is a replacement of the standard golang package bufio.
-package bufio
-
-import (
-	"bufio"
-	"io"
-)
-
-// OriginalReader invokes bufio.NewReader() from Golang standard library.
-func OriginalReader(reader io.Reader) *bufio.Reader {
-	return bufio.NewReader(reader)
-}
-
-// OriginalReaderSize invokes bufio.NewReaderSize() from Golang standard library.
-func OriginalReaderSize(reader io.Reader, size int) *bufio.Reader {
-	return bufio.NewReaderSize(reader, size)
-}