Skip to content

Commit

Permalink
rlp: add support for boolean encoding/decoding
Browse files Browse the repository at this point in the history
  • Loading branch information
karalabe committed Aug 13, 2015
1 parent 0dd6911 commit 1d24203
Show file tree
Hide file tree
Showing 4 changed files with 53 additions and 0 deletions.
29 changes: 29 additions & 0 deletions rlp/decode.go
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,8 @@ func makeDecoder(typ reflect.Type, tags tags) (dec decoder, err error) {
return decodeBigIntNoPtr, nil
case isUint(kind):
return decodeUint, nil
case kind == reflect.Bool:
return decodeBool, nil
case kind == reflect.String:
return decodeString, nil
case kind == reflect.Slice || kind == reflect.Array:
Expand Down Expand Up @@ -211,6 +213,15 @@ func decodeUint(s *Stream, val reflect.Value) error {
return nil
}

func decodeBool(s *Stream, val reflect.Value) error {
b, err := s.Bool()
if err != nil {
return wrapStreamError(err, val.Type())
}
val.SetBool(b)
return nil
}

func decodeString(s *Stream, val reflect.Value) error {
b, err := s.Bytes()
if err != nil {
Expand Down Expand Up @@ -697,6 +708,24 @@ func (s *Stream) uint(maxbits int) (uint64, error) {
}
}

// Bool reads an RLP string of up to 1 byte and returns its contents
// as an boolean. If the input does not contain an RLP string, the
// returned error will be ErrExpectedString.
func (s *Stream) Bool() (bool, error) {
num, err := s.uint(8)
if err != nil {
return false, err
}
switch num {
case 0:
return false, nil
case 1:
return true, nil
default:
return false, fmt.Errorf("rlp: invalid boolean value: %d", num)
}
}

// List starts decoding an RLP list. If the input does not contain a
// list, the returned error will be ErrExpectedList. When the list's
// end has been reached, any Stream operation will return EOL.
Expand Down
9 changes: 9 additions & 0 deletions rlp/decode_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ package rlp
import (
"bytes"
"encoding/hex"
"errors"
"fmt"
"io"
"math/big"
Expand Down Expand Up @@ -116,6 +117,9 @@ func TestStreamErrors(t *testing.T) {
{"817F", calls{"Uint"}, nil, ErrCanonSize},
{"8180", calls{"Uint"}, nil, nil},

// Non-valid boolean
{"02", calls{"Bool"}, nil, errors.New("rlp: invalid boolean value: 2")},

// Size tags must use the smallest possible encoding.
// Leading zero bytes in the size tag are also rejected.
{"8100", calls{"Uint"}, nil, ErrCanonSize},
Expand Down Expand Up @@ -315,6 +319,11 @@ var (
)

var decodeTests = []decodeTest{
// booleans
{input: "01", ptr: new(bool), value: true},
{input: "80", ptr: new(bool), value: false},
{input: "02", ptr: new(bool), error: "rlp: invalid boolean value: 2"},

// integers
{input: "05", ptr: new(uint32), value: uint32(5)},
{input: "80", ptr: new(uint32), value: uint32(0)},
Expand Down
11 changes: 11 additions & 0 deletions rlp/encode.go
Original file line number Diff line number Diff line change
Expand Up @@ -361,6 +361,8 @@ func makeWriter(typ reflect.Type) (writer, error) {
return writeBigIntNoPtr, nil
case isUint(kind):
return writeUint, nil
case kind == reflect.Bool:
return writeBool, nil
case kind == reflect.String:
return writeString, nil
case kind == reflect.Slice && isByte(typ.Elem()):
Expand Down Expand Up @@ -398,6 +400,15 @@ func writeUint(val reflect.Value, w *encbuf) error {
return nil
}

func writeBool(val reflect.Value, w *encbuf) error {
if val.Bool() {
w.str = append(w.str, 0x01)
} else {
w.str = append(w.str, 0x80)
}
return nil
}

func writeBigIntPtr(val reflect.Value, w *encbuf) error {
ptr := val.Interface().(*big.Int)
if ptr == nil {
Expand Down
4 changes: 4 additions & 0 deletions rlp/encode_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@ type encTest struct {
}

var encTests = []encTest{
// booleans
{val: true, output: "01"},
{val: false, output: "80"},

// integers
{val: uint32(0), output: "80"},
{val: uint32(127), output: "7F"},
Expand Down

0 comments on commit 1d24203

Please sign in to comment.