# Packages
No description provided by the author
No description provided by the author
The datamodel package defines the most essential interfaces for describing IPLD Data -- such as Node, NodePrototype, NodeBuilder, Link, and Path.
The fluent package offers helper utilities for using NodeAssembler
more tersely by providing an interface that handles all errors for you,
and allows use of closures for any recursive assembly
so that creating trees of data results in indentation for legibility.
No description provided by the author
No description provided by the author
Package 'must' provides another alternative to the 'fluent' package, providing many helpful functions for wrapping methods with multiple returns into a single return (converting errors into panics).
The 'node' package gathers various general purpose Node implementations;
the first one you should jump to is 'node/basicnode'.
Printer provides features for printing out IPLD nodes and their contained data in a human-readable diagnostic format.
No description provided by the author
The storage package contains interfaces for storage systems, and functions for using them.
No description provided by the author
This package provides functional utilities for traversing and transforming IPLD nodes.
# Functions
Decode parses the given bytes into a Node using the given Decoder function, returning a new Node or an error.
DecodeStreaming is like Decode, but works on an io.Reader for input.
DecodeStreamingUsingPrototype is like DecodeUsingPrototype, but works on an io.Reader for input.
DecodeUsingPrototype is like Decode, but with a NodePrototype parameter, which gives you control over the Node type you'll receive, and thus control over the memory layout, and ability to use advanced features like schemas.
DeepEqual reports whether x and y are "deeply equal" as IPLD nodes.
Encode serializes the given Node using the given Encoder function, returning the serialized data or an error.
EncodeStreaming is like Encode, but emits output to an io.Writer.
LoadSchema parses an IPLD Schema in its DSL form and compiles its types into a standalone TypeSystem.
LoadSchemaBytes is a shortcut for LoadSchema for the common case where the schema is available as a buffer or a string, such as via go:embed.
LoadSchemaBytes is a shortcut for LoadSchema for the common case where the schema is a file on disk.
Marshal accepts a pointer to a Go value and an IPLD schema type, and encodes the representation form of that data (which may be configured with the schema!) using the given Encoder function.
MarshalStreaming is like Marshal, but emits output to an io.Writer.
NewPath is an alias for datamodel.NewPath.
ParsePath is an alias for datamodel.ParsePath.
ParsePathSegment is an alias for datamodel.ParsePathSegment.
PathSegmentOfInt is an alias for datamodel.PathSegmentOfInt.
PathSegmentOfString is an alias for datamodel.PathSegmentOfString.
Unmarshal accepts a pointer to a Go value and an IPLD schema type, and fills the value with data by decoding into it with the given Decoder function.
UnmarshalStreaming is like Unmarshal, but works on an io.Reader for input.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Variables
No description provided by the author
Future: These aliases for the `KindSet_*` values may be dropped someday.
Future: These aliases for the `KindSet_*` values may be dropped someday.
Future: These aliases for the `KindSet_*` values may be dropped someday.
Future: These aliases for the `KindSet_*` values may be dropped someday.
Future: These aliases for the `KindSet_*` values may be dropped someday.
Future: These aliases for the `KindSet_*` values may be dropped someday.
Future: These aliases for the `KindSet_*` values may be dropped someday.
Future: These aliases for the `KindSet_*` values may be dropped someday.
Future: These aliases for the `KindSet_*` values may be dropped someday.
Future: These aliases for the `KindSet_*` values may be dropped someday.
Future: These aliases for the `KindSet_*` values may be dropped someday.
No description provided by the author
# Type aliases
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Future: These error type aliases may be dropped someday.
Future: These error type aliases may be dropped someday.
Future: These error type aliases may be dropped someday.
Future: These error type aliases may be dropped someday.
Future: These error type aliases may be dropped someday.
Future: These error type aliases may be dropped someday.
Future: These error type aliases may be dropped someday.
Future: These error type aliases may be dropped someday.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author