github.com/aquanetwork/aquachain@v1.7.8/rlp/doc.go (about)

     1  // Copyright 2014 The aquachain Authors
     2  // This file is part of the aquachain library.
     3  //
     4  // The aquachain library is free software: you can redistribute it and/or modify
     5  // it under the terms of the GNU Lesser General Public License as published by
     6  // the Free Software Foundation, either version 3 of the License, or
     7  // (at your option) any later version.
     8  //
     9  // The aquachain library is distributed in the hope that it will be useful,
    10  // but WITHOUT ANY WARRANTY; without even the implied warranty of
    11  // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
    12  // GNU Lesser General Public License for more details.
    13  //
    14  // You should have received a copy of the GNU Lesser General Public License
    15  // along with the aquachain library. If not, see <http://www.gnu.org/licenses/>.
    16  
    17  /*
    18  Package rlp implements the RLP serialization format.
    19  
    20  The purpose of RLP (Recursive Linear Prefix) is to encode arbitrarily
    21  nested arrays of binary data, and RLP is the main encoding method used
    22  to serialize objects in AquaChain. The only purpose of RLP is to encode
    23  structure; encoding specific atomic data types (eg. strings, ints,
    24  floats) is left up to higher-order protocols; in AquaChain integers
    25  must be represented in big endian binary form with no leading zeroes
    26  (thus making the integer value zero equivalent to the empty byte
    27  array).
    28  
    29  RLP values are distinguished by a type tag. The type tag precedes the
    30  value in the input stream and defines the size and kind of the bytes
    31  that follow.
    32  */
    33  package rlp