github.com/ipld/go-ipld-prime@v0.21.0/node/doc.go (about)

     1  /*
     2  The 'node' package gathers various general purpose Node implementations;
     3  the first one you should jump to is 'node/basicnode'.
     4  
     5  There's no code in this package itself; it's just for grouping.
     6  
     7  The `Node` interface itself is in the `ipld` package,
     8  which is the parent of this.
     9  
    10  The 'node/mixins' package contains reusable component code for building
    11  your own node implementations, should you desire to do so.
    12  This includes standardized behavioral tests (!), which are
    13  in the 'node/mixins/tests' package.
    14  
    15  Other planned subpackages include:
    16  a cbor-native Node implementation (which can optimize performance in some
    17  cases by lazily parsing serial	data, and also retaining it as byte slice
    18  references for minimizing reserialization work for small mutations);
    19  a Node implementation which works over golang native types by use of reflection;
    20  a Node implementation which supports Schema type constraints and works
    21  without compile-time/codegen support by delegating storage to another Node implementation;
    22  etc.
    23  
    24  You can create your own Node implementations, too.
    25  There's nothing special about being in this package.
    26  
    27  Other Node implementations not found here may include those which
    28  are output from Schema-powered codegen!
    29  */
    30  package node