Golint: make BufDagReader public
License: MIT Signed-off-by: Hector Sanjuan <hector@protocol.ai>
Hector Sanjuan committed
Feb 6, 2018 at 19:14 UTC
8bb45fda8ea250fce6eb351ece8a13d749742adc
3 files changed
+19
-13
unixfs/io/bufdagreader.go
+15
-9
@@ -6,27 +6,32 @@ import (
6
"io"
7
)
8
9
-type bufDagReader struct {
9
+// BufDagReader implements a DagReader that reads from a byte slice
10
+// using a bytes.Reader. It is used for RawNodes.
11
+type BufDagReader struct {
12
*bytes.Reader
13
}
14
13
-// newBufDagReader returns a DAG reader for the given byte slice.
15
+// NewBufDagReader returns a DAG reader for the given byte slice.
16
// BufDagReader is used to read RawNodes.
15
-func newBufDagReader(b []byte) *bufDagReader {
16
- return &bufDagReader{bytes.NewReader(b)}
17
+func NewBufDagReader(b []byte) *BufDagReader {
18
+ return &BufDagReader{bytes.NewReader(b)}
19
}
20
19
-var _ DagReader = (*bufDagReader)(nil)
21
+var _ DagReader = (*BufDagReader)(nil)
22
21
-func (*bufDagReader) Close() error {
23
+// Close is a nop.
24
+func (*BufDagReader) Close() error {
25
return nil
26
}
27
25
-func (rd *bufDagReader) CtxReadFull(ctx context.Context, b []byte) (int, error) {
28
+// CtxReadFull reads the slice onto b.
29
+func (rd *BufDagReader) CtxReadFull(ctx context.Context, b []byte) (int, error) {
30
return rd.Read(b)
31
}
32
29
-func (rd *bufDagReader) Offset() int64 {
33
+// Offset returns the current offset.
34
+func (rd *BufDagReader) Offset() int64 {
35
of, err := rd.Seek(0, io.SeekCurrent)
36
if err != nil {
37
panic("this should never happen " + err.Error())
@@ -34,7 +39,8 @@ func (rd *bufDagReader) Offset() int64 {
39
return of
40
}
41
37
-func (rd *bufDagReader) Size() uint64 {
42
+// Size returns the size of the buffer.
43
+func (rd *BufDagReader) Size() uint64 {
44
s := rd.Reader.Size()
45
if s < 0 {
46
panic("size smaller than 0 (impossible!!)")
unixfs/io/dagreader.go
+1
-1
@@ -43,7 +43,7 @@ type ReadSeekCloser interface {
43
func NewDagReader(ctx context.Context, n ipld.Node, serv ipld.NodeGetter) (DagReader, error) {
44
switch n := n.(type) {
45
case *mdag.RawNode:
46
- return newBufDagReader(n.RawData()), nil
46
+ return NewBufDagReader(n.RawData()), nil
47
case *mdag.ProtoNode:
48
pb := new(ftpb.Data)
49
if err := proto.Unmarshal(n.Data(), pb); err != nil {
unixfs/io/pbdagreader.go
+3
-3
@@ -57,7 +57,7 @@ func NewPBFileReader(ctx context.Context, n *mdag.ProtoNode, pb *ftpb.Data, serv
57
return &PBDagReader{
58
node: n,
59
serv: serv,
60
- buf: newBufDagReader(pb.GetData()),
60
+ buf: NewBufDagReader(pb.GetData()),
61
promises: make([]*ipld.NodePromise, len(curLinks)),
62
links: curLinks,
63
ctx: fctx,
@@ -119,7 +119,7 @@ func (dr *PBDagReader) precalcNextBuf(ctx context.Context) error {
119
dr.buf = NewPBFileReader(dr.ctx, nxt, pb, dr.serv)
120
return nil
121
case ftpb.Data_Raw:
122
- dr.buf = newBufDagReader(pb.GetData())
122
+ dr.buf = NewBufDagReader(pb.GetData())
123
return nil
124
case ftpb.Data_Metadata:
125
return errors.New("shouldnt have had metadata object inside file")
@@ -256,7 +256,7 @@ func (dr *PBDagReader) Seek(offset int64, whence int) (int64, error) {
256
if dr.buf != nil {
257
dr.buf.Close()
258
}
259
- dr.buf = newBufDagReader(pb.GetData()[offset:])
259
+ dr.buf = NewBufDagReader(pb.GetData()[offset:])
260
261
// start reading links from the beginning
262
dr.linkPosition = 0