coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-03-07 01:08:08 +08:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Add some documentation on the intended purpose of GetLinks.

Browse Source 
License: MIT
Signed-off-by: Kevin Atkinson <k@kevina.org>
This commit is contained in:
Kevin Atkinson 2017-02-21 12:48:03 -05:00
parent c3346ad9d5
commit e4bbd246ec
1 changed files with 9 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
merkledag/merkledag.go
View File

@ -36,8 +36,10 @@ type DAGService interface {
}
type LinkService interface {
// Return all links for a node, may be more effect than
// calling Get in DAGService
// GetLinks return all links for a node. The complete node does not
// necessarily have to exist locally, or at all. For example, raw
// leaves cannot possibly have links so there is no need to look
// at the node.
GetLinks(context.Context, *cid.Cid) ([]*node.Link, error)
GetOfflineLinkService() LinkService
@ -114,6 +116,8 @@ func decodeBlock(b blocks.Block) (node.Node, error) {
}
}
// GetLinks return the links for the node, the node doesn't necessarily have
// to exist locally.
func (n *dagService) GetLinks(ctx context.Context, c *cid.Cid) ([]*node.Link, error) {
if c.Type() == cid.Raw {
return nil, nil
@ -138,8 +142,9 @@ func (n *dagService) Remove(nd node.Node) error {
return n.Blocks.DeleteBlock(nd)
}
// get the links for a node, from the node, bypassing the
// LinkService
// GetLinksDirect creates a function to get the links for a node, from
// the node, bypassing the LinkService. If the node does not exist
// locally (and can not be retrieved) an error will be returned.
func GetLinksDirect(serv DAGService) GetLinks {
return func(ctx context.Context, c *cid.Cid) ([]*node.Link, error) {
node, err := serv.Get(ctx, c)