Documentation
¶
Index ¶
- Variables
- func AppendUint64(b []byte, i uint64) []byte
- func CountValues(b []byte) (int, error)
- func Decode(r io.Reader, val interface{}) error
- func DecodeBytes(b []byte, val interface{}) error
- func Encode(w io.Writer, val interface{}) error
- func EncodeToBytes(val interface{}) ([]byte, error)
- func EncodeToReader(val interface{}) (size int, r io.Reader, err error)
- func IntSize(x uint64) int
- func ListSize(contentSize uint64) uint64
- func SplitList(b []byte) (content, rest []byte, err error)
- func SplitString(b []byte) (content, rest []byte, err error)
- func SplitUint64(b []byte) (x uint64, rest []byte, err error)
- type ByteReader
- type Decoder
- type Encoder
- type Kind
- type RawValue
- type Stream
- func (s *Stream) Bool() (bool, error)
- func (s *Stream) Bytes() ([]byte, error)
- func (s *Stream) Decode(val interface{}) error
- func (s *Stream) Kind() (kind Kind, size uint64, err error)
- func (s *Stream) List() (size uint64, err error)
- func (s *Stream) ListEnd() error
- func (s *Stream) Raw() ([]byte, error)
- func (s *Stream) Reset(r io.Reader, inputLimit uint64)
- func (s *Stream) Uint() (uint64, error)
Constants ¶
This section is empty.
Variables ¶
var ( ErrExpectedString = errors.New("rlp: expected String or Byte") ErrExpectedList = errors.New("rlp: expected List") ErrCanonInt = errors.New("rlp: non-canonical integer format") ErrCanonSize = errors.New("rlp: non-canonical size information") ErrElemTooLarge = errors.New("rlp: element is larger than containing list") ErrValueTooLarge = errors.New("rlp: value size exceeds available input length") ErrMoreThanOneValue = errors.New("rlp: input contains more than one value") )
var ( // Common encoded values. // These are useful when implementing EncodeRLP. EmptyString = []byte{0x80} EmptyList = []byte{0xC0} )
var EOL = errors.New("rlp: end of list")
EOL is returned when the end of the current list has been reached during streaming.
Functions ¶
func AppendUint64 ¶
AppendUint64 appends the RLP encoding of i to b, and returns the resulting slice.
func CountValues ¶
CountValues counts the number of encoded values in b.
func Decode ¶
Decode parses RLP-encoded data from r and stores the result in the value pointed to by val. Please see package-level documentation for the decoding rules. Val must be a non-nil pointer.
If r does not implement ByteReader, Decode will do its own buffering.
Note that Decode does not set an input limit for all readers and may be vulnerable to panics cause by huge value sizes. If you need an input limit, use
NewStream(r, limit).Decode(val)
func DecodeBytes ¶
DecodeBytes parses RLP data from b into val. Please see package-level documentation for the decoding rules. The input must contain exactly one value and no trailing data.
func Encode ¶
Encode writes the RLP encoding of val to w. Note that Encode may perform many small writes in some cases. Consider making w buffered.
Please see package-level documentation of encoding rules.
func EncodeToBytes ¶
EncodeToBytes returns the RLP encoding of val. Please see package-level documentation for the encoding rules.
func EncodeToReader ¶
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.
Please see the documentation of Encode for the encoding rules.
func SplitList ¶
SplitList splits b into the content of a list and any remaining bytes after the list.
func SplitString ¶
SplitString splits b into the content of an RLP string and any remaining bytes after the string.
Types ¶
type ByteReader ¶
type ByteReader interface {
io.Reader
io.ByteReader
}
ByteReader must be implemented by any input reader for a Stream. It is implemented by e.g. bufio.Reader and bytes.Reader.
type Decoder ¶
Decoder is implemented by types that require custom RLP decoding rules or need to decode into private fields.
The DecodeRLP method should read one value from the given Stream. It is not forbidden to read less or more, but it might be confusing.
type Encoder ¶
type Encoder interface {
// EncodeRLP should write the RLP encoding of its receiver to w.
// If the implementation is a pointer method, it may also be
// called for nil pointers.
//
// Implementations should generate valid RLP. The data written is
// not verified at the moment, but a future version might. It is
// recommended to write only a single value but writing multiple
// values or no value at all is also permitted.
EncodeRLP(io.Writer) error
}
Encoder is implemented by types that require custom encoding rules or want to encode private fields.
type Kind ¶
type Kind int8
Kind represents the kind of value contained in an RLP stream.
type RawValue ¶
type RawValue []byte
RawValue represents an encoded RLP value and can be used to delay RLP decoding or to precompute an encoding. Note that the decoder does not verify whether the content of RawValues is valid RLP.
type Stream ¶
type Stream struct {
// contains filtered or unexported fields
}
Stream can be used for piecemeal decoding of an input stream. This is useful if the input is very large or if the decoding rules for a type depend on the input structure. Stream does not keep an internal buffer. After decoding a value, the input reader will be positioned just before the type information for the next value.
When decoding a list and the input position reaches the declared length of the list, all operations will return error EOL. The end of the list must be acknowledged using ListEnd to continue reading the enclosing list.
Stream is not safe for concurrent use.
func NewListStream ¶
NewListStream creates a new stream that pretends to be positioned at an encoded list of the given length.
func NewStream ¶
NewStream creates a new decoding stream reading from r.
If r implements the ByteReader interface, Stream will not introduce any buffering.
For non-toplevel values, Stream returns ErrElemTooLarge for values that do not fit into the enclosing list.
Stream supports an optional input limit. If a limit is set, the size of any toplevel value will be checked against the remaining input length. Stream operations that encounter a value exceeding the remaining input length will return ErrValueTooLarge. The limit can be set by passing a non-zero value for inputLimit.
If r is a bytes.Reader or strings.Reader, the input limit is set to the length of r's underlying data unless an explicit limit is provided.
func (*Stream) Bool ¶
Bool reads an RLP string of up to 1 byte and returns its contents as a boolean. If the input does not contain an RLP string, the returned error will be ErrExpectedString.
func (*Stream) Bytes ¶
Bytes reads an RLP string and returns its contents as a byte slice. If the input does not contain an RLP string, the returned error will be ErrExpectedString.
func (*Stream) Decode ¶
Decode decodes a value and stores the result in the value pointed to by val. Please see the documentation for the Decode function to learn about the decoding rules.
func (*Stream) Kind ¶
Kind returns the kind and size of the next value in the input stream.
The returned size is the number of bytes that make up the value. For kind == Byte, the size is zero because the value is contained in the type tag.
The first call to Kind will read size information from the input reader and leave it positioned at the start of the actual bytes of the value. Subsequent calls to Kind (until the value is decoded) will not advance the input reader and return cached information.
func (*Stream) List ¶
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.
func (*Stream) ListEnd ¶
ListEnd returns to the enclosing list. The input reader must be positioned at the end of a list.
Source Files