coosld/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2026-02-28 13:57:52 +08:00
Code Issues Actions 13 Packages Projects Releases Wiki Activity

coreunix: fix Add() docs regarding pinning

Browse Source 
License: MIT
Signed-off-by: Lars Gierth <larsg@systemli.org>
This commit is contained in:
Lars Gierth 2016-12-16 15:13:09 +01:00
parent e2ba43c12d
commit 71a03fe35d
1 changed files with 7 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
core/coreunix/add.go
View File

@ -89,7 +89,7 @@ func NewAdder(ctx context.Context, p pin.Pinner, bs bstore.GCBlockstore, ds dag.
}
// Internal structure for holding the switches passed to the `add` call
// Adder holds the switches passed to the `add` command.
type Adder struct {
ctx context.Context
pinning pin.Pinner
@ -114,7 +114,7 @@ func (adder *Adder) SetMfsRoot(r *mfs.Root) {
adder.mr = r
}
// Perform the actual add & pin locally, outputting results to reader
// Constructs a node from reader's data, and adds it. Doesn't pin.
func (adder Adder) add(reader io.Reader) (node.Node, error) {
chnk, err := chunk.FromString(reader, adder.Chunker)
if err != nil {
@ -251,12 +251,14 @@ func (adder *Adder) outputDirs(path string, fsn mfs.FSNode) error {
}
}
// Add builds a merkledag from the a reader, pinning all objects to the local
// datastore. Returns a key representing the root node.
// Add builds a merkledag node from a reader, adds it to the blockstore,
// and returns the key representing that node.
// If you want to pin it, use NewAdder() and Adder.PinRoot().
func Add(n *core.IpfsNode, r io.Reader) (string, error) {
return AddWithContext(n.Context(), n, r)
}
// AddWithContext does the same as Add, but with a custom context.
func AddWithContext(ctx context.Context, n *core.IpfsNode, r io.Reader) (string, error) {
defer n.Blockstore.PinLock().Unlock()
@ -357,7 +359,7 @@ func (adder *Adder) addNode(node node.Node, path string) error {
return nil
}
// Add the given file while respecting the adder.
// AddFile adds the given file while respecting the adder.
func (adder *Adder) AddFile(file files.File) error {
if adder.Pin {
adder.unlocker = adder.blockstore.PinLock()