• Felix Lange's avatar
    rlp/rlpgen: RLP encoder code generator (#24251) · 9b93564e
    Felix Lange authored
    This change adds a code generator tool for creating EncodeRLP method
    implementations. The generated methods will behave identically to the
    reflect-based encoder, but run faster because there is no reflection overhead.
    
    Package rlp now provides the EncoderBuffer type for incremental encoding. This
    is used by generated code, but the new methods can also be useful for
    hand-written encoders.
    
    There is also experimental support for generating DecodeRLP, and some new
    methods have been added to the existing Stream type to support this. Creating
    decoders with rlpgen is not recommended at this time because the generated
    methods create very poor error reporting.
    
    More detail about package rlp changes:
    
    * rlp: externalize struct field processing / validation
    
    This adds a new package, rlp/internal/rlpstruct, in preparation for the
    RLP encoder generator.
    
    I think the struct field rules are subtle enough to warrant extracting
    this into their own package, even though it means that a bunch of
    adapter code is needed for converting to/from rlpstruct.Type.
    
    * rlp: add more decoder methods (for rlpgen)
    
    This adds new methods on rlp.Stream:
    
    - Uint64, Uint32, Uint16, Uint8, BigInt
    - ReadBytes for decoding into []byte
    - MoreDataInList - useful for optional list elements
    
    * rlp: expose encoder buffer (for rlpgen)
    
    This exposes the internal encoder buffer type for use in EncodeRLP
    implementations.
    
    The new EncoderBuffer type is a sort-of 'opaque handle' for a pointer to
    encBuffer. It is implemented this way to ensure the global encBuffer pool
    is handled correctly.
    9b93564e
encoder_example_test.go 1.39 KB