Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rlp: fix some golint warnings #16659

Merged
merged 4 commits into from
May 8, 2018
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 14 additions & 7 deletions rlp/decode.go
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ import (
"math/big"
"reflect"
"strings"
customErr "github.com/pkg/errors"
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why did you introduce a new package?

)

var (
Expand Down Expand Up @@ -274,9 +275,8 @@ func makeListDecoder(typ reflect.Type, tag tags) (decoder, error) {
if etype.Kind() == reflect.Uint8 && !reflect.PtrTo(etype).Implements(decoderInterface) {
if typ.Kind() == reflect.Array {
return decodeByteArray, nil
} else {
return decodeByteSlice, nil
}
return decodeByteSlice, nil
}
etypeinfo, err := cachedTypeInfo1(etype, tags{})
if err != nil {
Expand Down Expand Up @@ -536,6 +536,8 @@ func decodeDecoder(s *Stream, val reflect.Value) error {
// Kind represents the kind of value contained in an RLP stream.
type Kind int

// Const list indicates the kind of value in an RLP stream
// and its next value is incremented by Kind().
const (
Byte Kind = iota
String
Expand All @@ -558,18 +560,23 @@ func (k Kind) String() string {
var (
// EOL is returned when the end of the current list
// has been reached during streaming.
EOL = errors.New("rlp: end of list")
EOL = customErr.New(fmt.Sprintf("rlp: end of list"))

// Actual Errors
//ActualErrors

//ErrExpectedString is returned if kind is not string or Byte.
ErrExpectedString = errors.New("rlp: expected String or Byte")
//ErrExpectedList is returned if kind is not a list.
ErrExpectedList = errors.New("rlp: expected List")
//ErrCanonInt is returned if integer is a non-canonical format .
ErrCanonInt = errors.New("rlp: non-canonical integer format")
//ErrCanonSize is returned if integer has non-canonical size information.
ErrCanonSize = errors.New("rlp: non-canonical size information")
//ErrElemTooLarge is returned if the element is larger than the list.
ErrElemTooLarge = errors.New("rlp: element is larger than containing list")
//ErrValueTooLarge is returned if the element is larger than available input length.
ErrValueTooLarge = errors.New("rlp: value size exceeds available input length")

// This error is reported by DecodeBytes if the slice contains
// additional data after the first RLP value.
//ErrMoreThanOneValue is reported by DecodeBytes if the slice contains additional data after the first RLP value.
ErrMoreThanOneValue = errors.New("rlp: input contains more than one value")

// internal errors
Expand Down
25 changes: 11 additions & 14 deletions rlp/encode.go
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@ import (
)

var (
// Common encoded values.
// These are useful when implementing EncodeRLP.
//EmptyString accepts a common encoded value useful for implementing EncodeRLP.
EmptyString = []byte{0x80}
//EmptyList accepts a common encoded value useful for implementing EncodeRLP.
EmptyList = []byte{0xC0}
)

Expand Down Expand Up @@ -92,7 +92,7 @@ func Encode(w io.Writer, val interface{}) error {
return eb.toWriter(w)
}

// EncodeBytes returns the RLP encoding of val.
// EncodeToBytes returns the RLP encoding of val.
// Please see the documentation of Encode for the encoding rules.
func EncodeToBytes(val interface{}) ([]byte, error) {
eb := encbufPool.Get().(*encbuf)
Expand All @@ -104,7 +104,7 @@ func EncodeToBytes(val interface{}) ([]byte, error) {
return eb.toBytes(), nil
}

// EncodeReader returns a reader from which the RLP encoding of val
// EncodeToReader returns a reader from which the RLP encoding of val
// can be read. The returned size is the total size of the encoded
// data.
//
Expand Down Expand Up @@ -151,11 +151,10 @@ func puthead(buf []byte, smalltag, largetag byte, size uint64) int {
if size < 56 {
buf[0] = smalltag + byte(size)
return 1
} else {
sizesize := putint(buf[1:], size)
buf[0] = largetag + byte(sizesize)
return sizesize + 1
}
sizesize := putint(buf[1:], size)
buf[0] = largetag + byte(sizesize)
return sizesize + 1
}

// encbufs are pooled.
Expand Down Expand Up @@ -218,7 +217,7 @@ func (w *encbuf) list() *listhead {
func (w *encbuf) listEnd(lh *listhead) {
lh.size = w.size() - lh.offset - lh.size
if lh.size < 56 {
w.lhsize += 1 // length encoded into kind tag
w.lhsize ++ // length encoded into kind tag
} else {
w.lhsize += 1 + intsize(uint64(lh.size))
}
Expand Down Expand Up @@ -322,10 +321,9 @@ func (r *encReader) next() []byte {
p := r.buf.str[r.strpos:head.offset]
r.strpos += sizebefore
return p
} else {
r.lhpos++
return head.encode(r.buf.sizebuf)
}
r.lhpos++
return head.encode(r.buf.sizebuf)

case r.strpos < len(r.buf.str):
// String data at the end, after all list headers.
Expand Down Expand Up @@ -576,9 +574,8 @@ func makePtrWriter(typ reflect.Type) (writer, error) {
writer := func(val reflect.Value, w *encbuf) error {
if val.IsNil() {
return nilfunc(w)
} else {
return etypeinfo.writer(val.Elem(), w)
}
return etypeinfo.writer(val.Elem(), w)
}
return writer, err
}
Expand Down