README
¶
FastRlp
FastRlp is a high performant encoding/decoding library for the RLP Ethereum format. This library is based on fastjson.
Usage
FastRlp does not uses reflect to avoid bottlenecks. It provides a single value primitive that can be encoded or decoded into any specific type.
Encode:
a := &fastrlp.Arena{}
// Encode a uint
v := a.NewUint(300)
buf := v.MarshalTo(nil)
// Encode an array
v = a.NewArray()
v.Set(a.NewUint(300))
buf = v.MarshalTo(nil)
You can find more examples here.
Decode:
p := &fastrlp.Parser{}
v, err := p.Parse([]byte{0x01})
if err != nil {
panic(err)
}
num, err := v.GetUint64()
if err != nil {
panic(err)
}
fmt.Println(num)
Benchmark
$ go-rlp-test go test -v ./. -run=XX -bench=.
goos: linux
goarch: amd64
pkg: github.com/ferranbt/go-rlp-test
BenchmarkDecode100HeadersGeth-8 10000 196183 ns/op 32638 B/op 1002 allocs/op
BenchmarkEncode100HeadersGeth-8 10000 179328 ns/op 88471 B/op 1003 allocs/op
BenchmarkDecode100HeadersFastRlp-8 30000 57179 ns/op 16 B/op 0 allocs/op
BenchmarkEncode100HeadersFastRlp-8 30000 43967 ns/op 23 B/op 0 allocs/op
PASS
ok github.com/ferranbt/go-rlp-test 7.890s
Documentation
¶
Index ¶
- func Fuzz(num int, base FuzzObject, opts ...FuzzOption) error
- func MarshalRLP(m Marshaler) ([]byte, error)
- func UnmarshalRLP(buf []byte, m Unmarshaler) error
- type Arena
- func (a *Arena) NewArray() *Value
- func (a *Arena) NewBigInt(b *big.Int) *Value
- func (a *Arena) NewBool(b bool) *Value
- func (a *Arena) NewBytes(b []byte) *Value
- func (a *Arena) NewCopyBytes(b []byte) *Value
- func (a *Arena) NewFalse() *Value
- func (a *Arena) NewNull() *Value
- func (a *Arena) NewNullArray() *Value
- func (a *Arena) NewString(s string) *Value
- func (a *Arena) NewTrue() *Value
- func (a *Arena) NewUint(i uint64) *Value
- func (a *Arena) Reset()
- type ArenaPool
- type FuzzError
- type FuzzObject
- type FuzzOption
- type Fuzzer
- type Keccak
- type Marshaler
- type Parser
- type ParserPool
- type Type
- type Unmarshaler
- type Value
- func (v *Value) Bytes() ([]byte, error)
- func (v *Value) Elems() int
- func (v *Value) Get(i int) *Value
- func (v *Value) GetAddr(buf []byte) error
- func (v *Value) GetBigInt(b *big.Int) error
- func (v *Value) GetBool() (bool, error)
- func (v *Value) GetByte() (byte, error)
- func (v *Value) GetBytes(dst []byte, bits ...int) ([]byte, error)
- func (v *Value) GetElems() ([]*Value, error)
- func (v *Value) GetHash(buf []byte) error
- func (v *Value) GetString() (string, error)
- func (v *Value) GetUint64() (uint64, error)
- func (v *Value) Len() uint64
- func (v *Value) MarshalTo(dst []byte) []byte
- func (v *Value) Raw() []byte
- func (v *Value) Set(vv *Value)
- func (v *Value) Type() Type
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Fuzz ¶
func Fuzz(num int, base FuzzObject, opts ...FuzzOption) error
func UnmarshalRLP ¶
func UnmarshalRLP(buf []byte, m Unmarshaler) error
UnmarshalRLP unmarshals an RLP object
Types ¶
type Arena ¶
type Arena struct {
// contains filtered or unexported fields
}
Arena is a pool of RLP values.
func (*Arena) NewCopyBytes ¶
NewCopyBytes returns a bytes value that copies the input.
func (*Arena) NewNullArray ¶
NewNullArray returns a null array value.
type ArenaPool ¶
type ArenaPool struct {
// contains filtered or unexported fields
}
ArenaPool may be used for pooling Arenas for similarly typed RLPs.
var DefaultArenaPool ArenaPool
DefaultArenaPool is a default ArenaPool
type FuzzObject ¶
type FuzzObject interface {
Marshaler
Unmarshaler
}
type FuzzOption ¶
type FuzzOption func(f *Fuzzer)
func WithDefaults ¶
func WithDefaults(fnc func(FuzzObject)) FuzzOption
func WithPostHook ¶
func WithPostHook(fnc func(FuzzObject) error) FuzzOption
type Keccak ¶
type Keccak struct {
// contains filtered or unexported fields
}
Keccak is the sha256 keccak hash
func NewKeccak256 ¶
func NewKeccak256() *Keccak
type Marshaler ¶
type Marshaler interface {
MarshalRLPTo(dst []byte) ([]byte, error)
MarshalRLPWith(a *Arena) (*Value, error)
}
Marshaler is the interface implemented by types that can marshal themselves into valid RLP messages.
type Parser ¶
type Parser struct {
// contains filtered or unexported fields
}
Parser is a RLP parser
type ParserPool ¶
type ParserPool struct {
// contains filtered or unexported fields
}
ParserPool may be used for pooling Parsers for similarly typed RLPs.
var DefaultParserPool ParserPool
DefaultParserPool is a default ParserPool
type Unmarshaler ¶
Unmarshaler is the interface implemented by types that can unmarshal a RLP description of themselves
type Value ¶
type Value struct {
// contains filtered or unexported fields
}
Value is an RLP value
Source Files