Commit d6fbc28b authored by hannahhoward's avatar hannahhoward

chore(ipldbridge): add comments

parent b6c8a00e
...@@ -39,10 +39,24 @@ type TraversalReason = ipldtraversal.TraversalReason ...@@ -39,10 +39,24 @@ type TraversalReason = ipldtraversal.TraversalReason
// IPLDBridge is an interface for making calls to IPLD, which can be // IPLDBridge is an interface for making calls to IPLD, which can be
// replaced with alternative implementations // replaced with alternative implementations
type IPLDBridge interface { type IPLDBridge interface {
// ComposeLinkLoader converts a raw block loader into an IPLD node loader.
ComposeLinkLoader(actualLoader RawLoader) LinkLoader ComposeLinkLoader(actualLoader RawLoader) LinkLoader
// ValidateSelectorSpec verifies if a node matches the selector spec.
ValidateSelectorSpec(cidRootedSelector ipld.Node) []error ValidateSelectorSpec(cidRootedSelector ipld.Node) []error
// EncodeNode encodes an IPLD Node to bytes for network transfer.
EncodeNode(ipld.Node) ([]byte, error) EncodeNode(ipld.Node) ([]byte, error)
// DecodeNode decodes bytes crossing a network to an IPLD Node.
DecodeNode([]byte) (ipld.Node, error) DecodeNode([]byte) (ipld.Node, error)
// DecodeSelectorSpec checks if a generic IPLD node is a selector spec,
// and if so, converts it to a root node and a go-ipld-prime Selector.
DecodeSelectorSpec(cidRootedSelector ipld.Node) (ipld.Node, Selector, error) DecodeSelectorSpec(cidRootedSelector ipld.Node) (ipld.Node, Selector, error)
// Traverse performs a selector traversal, starting at a given root, using the given selector,
// and the given link loader. The given visit function will be called for each node
// visited.
Traverse(ctx context.Context, loader LinkLoader, root ipld.Node, s Selector, fn AdvVisitFn) error Traverse(ctx context.Context, loader LinkLoader, root ipld.Node, s Selector, fn AdvVisitFn) error
} }
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment