fluencelabs/tendermint
1
0
Fork 0
mirror of https://github.com/fluencelabs/tendermint synced 2025-06-22 09:21:32 +00:00
Code Issues Projects Releases Wiki Activity

fix binary/README

Browse Source
This commit is contained in:
Jae Kwon
2014-12-31 20:42:02 -08:00
parent 7b64774a32
commit 8a18a11431
1 changed files with 16 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
binary/README.md
View File

@ -123,9 +123,8 @@ func GreeterEncoder(o interface{}, w io.Writer, n *int64, err *error) {
} }
} }
func GreeterDecoder(r *bytes.Reader, n *int64, err *error) interface{} { func GreeterDecoder(r Unreader, n *int64, err *error) interface{} {
// We must peek the type byte because ReadBinary() expects it. switch t := ReadByte(r, n, err); t {
switch t := PeekByte(r, n, err); t {
case GreeterTypeDog: case GreeterTypeDog:
return ReadBinary(Dog{}, r, n, err) return ReadBinary(Dog{}, r, n, err)
case GreeterTypeCat: case GreeterTypeCat:
@ -149,7 +148,7 @@ Sometimes you want to always prefix a globally unique type byte while encoding,
whether or not the declared type is an interface or concrete type. whether or not the declared type is an interface or concrete type.
In this case, you can declare a "TypeByte() byte" function on the struct (as In this case, you can declare a "TypeByte() byte" function on the struct (as
a value receiver, not a pointer receiver!), and you can skip the declaration of a value receiver, not a pointer receiver!), and you can skip the declaration of
a custom decoder. a custom encoder. The decoder must "peek" the byte instead of consuming it.
```go ```go
@ -161,6 +160,19 @@ type Cat struct{}
func (c Cat) TypeByte() byte { return GreeterTypeCat } func (c Cat) TypeByte() byte { return GreeterTypeCat }
func (c Cat) Greet() string { return "Meow!" } func (c Cat) Greet() string { return "Meow!" }
func GreeterDecoder(r Unreader, n *int64, err *error) interface{} {
// We must peek the type byte because ReadBinary() expects it.
switch t := PeekByte(r, n, err); t {
case GreeterTypeDog:
return ReadBinary(Dog{}, r, n, err)
case GreeterTypeCat:
return ReadBinary(Cat{}, r, n, err)
default:
*err = errors.New(fmt.Sprintf("Unknown greeter type byte %X", t))
return nil
}
}
var _ = RegisterType(&TypeInfo{ var _ = RegisterType(&TypeInfo{
Type: reflect.TypeOf((*Greeter)(nil)).Elem(), Type: reflect.TypeOf((*Greeter)(nil)).Elem(),
Decoder: GreeterDecoder, Decoder: GreeterDecoder,