ipldbridge

Documentation

Index

• func ErrDoNotFollow() error
• type AdvVisitFn
• type ExploreFieldsSpecBuilder
• type IPLDBridge
  • func NewIPLDBridge() IPLDBridge
• type LinkContext
• type ListBuilder
• type Loader
• type MapBuilder
• type NodeBuilder
• type Selector
• type SelectorSpec
• type SelectorSpecBuilder
• type SimpleNode
• type StoreCommitter
• type Storer
• type TraversalConfig
• type TraversalProgress
• type TraversalReason
• type VisitFn

Functions

func ErrDoNotFollow

func ErrDoNotFollow() error

ErrDoNotFollow is just a wrapper for whatever IPLD's ErrDoNotFollow ends up looking like

Types

type AdvVisitFn

type AdvVisitFn = ipldtraversal.AdvVisitFn

AdvVisitFn is an alias from ipld, in case it's renamed/moved.

type ExploreFieldsSpecBuilder

type ExploreFieldsSpecBuilder = selectorbuilder.ExploreFieldsSpecBuilder

ExploreFieldsSpecBuilder is alias from ipld, in case it's renamed/moved.

type IPLDBridge

type IPLDBridge interface {

	// EncodeNode encodes an IPLD Node to bytes for network transfer.
	EncodeNode(ipld.Node) ([]byte, error)

	// DecodeNode decodes bytes crossing a network to an IPLD Node.
	DecodeNode([]byte) (ipld.Node, error)

	// ParseSelector checks if a generic IPLD node is a selector spec,
	// and if so, a go-ipld-prime Selector.
	ParseSelector(selector 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 Loader, root ipld.Link, s Selector, fn AdvVisitFn) error

	// WalkMatching is a wrapper around direct selector traversal
	WalkMatching(node ipld.Node, s Selector, fn VisitFn) error
}

IPLDBridge is an interface for making calls to IPLD, which can be replaced with alternative implementations

func NewIPLDBridge

func NewIPLDBridge() IPLDBridge

NewIPLDBridge returns an IPLD Bridge.

type LinkContext

type LinkContext = ipld.LinkContext

LinkContext is an alias from ipld, in case it's renamed/moved.

type ListBuilder

type ListBuilder = fluent.ListBuilder

ListBuilder is an alias from ipld fluent, in case it's moved

type Loader

type Loader = ipld.Loader

Loader is an alias from ipld, in case it's renamed/moved.

type MapBuilder

type MapBuilder = fluent.MapBuilder

MapBuilder is an alias from ipld fluent, in case it's moved

type NodeBuilder

type NodeBuilder = fluent.NodeBuilder

NodeBuilder is an alias from the ipld fluent nodebuilder, in case it's moved

type Selector

type Selector = ipldselector.Selector

Selector is an alias from ipld, in case it's renamed/moved.

type SelectorSpec

type SelectorSpec = selectorbuilder.SelectorSpec

SelectorSpec is alias from ipld, in case it's renamed/moved.

type SelectorSpecBuilder

type SelectorSpecBuilder = selectorbuilder.SelectorSpecBuilder

SelectorSpecBuilder is alias from ipld, in case it's renamed/moved.

type SimpleNode

type SimpleNode = fluent.Node

SimpleNode is an alias from ipld fluent, to refer to its non error based node struct

type StoreCommitter

type StoreCommitter = ipld.StoreCommitter

StoreCommitter is an alias from ipld, in case it's renamed/moved.

type Storer

type Storer = ipld.Storer

Storer is an alias from ipld, in case it's renamed/moved.

type TraversalConfig

type TraversalConfig = ipldtraversal.Config

TraversalConfig is an alias from ipld, in case it's renamed/moved.

type TraversalProgress

type TraversalProgress = ipldtraversal.Progress

TraversalProgress is an alias from ipld, in case it's renamed/moved.

type TraversalReason

type TraversalReason = ipldtraversal.VisitReason

TraversalReason is an alias from ipld, in case it's renamed/moved.

type VisitFn

type VisitFn = ipldtraversal.VisitFn

VisitFn is an alias from ipld, in case it's renamed/moved