Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

rlp: improve nil pointer handling #20064

Merged
merged 3 commits into from
Sep 13, 2019
Merged

rlp: improve nil pointer handling #20064

merged 3 commits into from
Sep 13, 2019

Commits on Sep 12, 2019

  1. rlp: improve nil pointer handling 

    In both encoder and decoder, the rules for encoding nil pointers were a
bit hard to understand, and didn't leave much choice. Since RLP allows
two empty values (empty list, empty string), any protocol built on RLP
must choose either of these values to represent the null value in a
certain context.

This change adds choice in the form of two new struct tags, "nilString"
and "nilList". These can be used to specify how a nil pointer value is
encoded. The "nil" tag still exists, but its implementation is now
explicit and defines exactly how nil pointers are handled in a single
place.

Another important change in this commit is how nil pointers and the
Encoder interface interact. The EncodeRLP method was previously called
even on nil values, which was supposed to give users a choice of how
their value would be handled when nil. It turns out this is a stupid
idea. If you create a network protocol containing an object defined in
another package, it's better to be able to say that the object should be
a list or string when nil in the definition of the protocol message
rather than defining the encoding of nil on the object itself.

As of this commit, the encoding rules for pointers now take precedence
over the Encoder interface rule. I think the "nil" tag will work fine
for most cases. For special kinds of objects which are a struct in Go
but strings in RLP, code using the object can specify the desired
encoding of nil using the "nilString" and "nilList" tags.
    @fjl
    fjl committed Sep 12, 2019
    Configuration menu
    Copy the full SHA
    ea2e659 View commit details
    Browse the repository at this point in the history

  2. rlp: propagate struct field type errors 

    If a struct contained fields of undecodable type, the encoder and
decoder would panic instead of returning an error. Fix this by
propagating type errors in makeStruct{Writer,Decoder} and add a test.
    @fjl
    fjl committed Sep 12, 2019
    Configuration menu
    Copy the full SHA
    2d98862 View commit details
    Browse the repository at this point in the history

  3. rlp: save one line

    @fjl
    fjl committed Sep 12, 2019
    Configuration menu
    Copy the full SHA
    44ca09e View commit details
    Browse the repository at this point in the history