docs for coreunix add method impls
License: MIT Signed-off-by: ForrestWeston <forrest@protocol.ai>
ForrestWeston committed
Jan 22, 2018 at 14:48 UTC
1c1149675e81e7d5daacc0fa68c12111af962a04
1 file changed
+7
core/coreunix/add.go
+7
@@ -73,6 +73,7 @@ type AddedObject struct {
73
Size string `json:",omitempty"`
74
}
75
76
+// NewAdder Returns a new Adder used for a file add operation.
77
func NewAdder(ctx context.Context, p pin.Pinner, bs bstore.GCBlockstore, ds dag.DAGService) (*Adder, error) {
78
return &Adder{
79
ctx: ctx,
@@ -126,6 +127,7 @@ func (adder *Adder) mfsRoot() (*mfs.Root, error) {
127
return adder.mroot, nil
128
}
129
130
+// SetMfsRoot sets `r` as the root for Adder.
131
func (adder *Adder) SetMfsRoot(r *mfs.Root) {
132
adder.mroot = r
133
}
@@ -152,6 +154,7 @@ func (adder *Adder) add(reader io.Reader) (node.Node, error) {
154
return balanced.BalancedLayout(params.New(chnk))
155
}
156
157
+// RootNode returns the root node of the Added.
158
func (adder *Adder) RootNode() (node.Node, error) {
159
// for memoizing
160
if adder.root != nil {
@@ -181,6 +184,8 @@ func (adder *Adder) RootNode() (node.Node, error) {
184
return root, err
185
}
186
187
+// Recursively pins the root node of Adder and
188
+// writes the pin state to the backing datastore.
189
func (adder *Adder) PinRoot() error {
190
root, err := adder.RootNode()
191
if err != nil {
@@ -207,6 +212,7 @@ func (adder *Adder) PinRoot() error {
212
return adder.pinning.Flush()
213
}
214
215
+// Finalize flushes the mfs root directory and returns the mfs root node.
216
func (adder *Adder) Finalize() (node.Node, error) {
217
mr, err := adder.mfsRoot()
218
if err != nil {
@@ -566,6 +572,7 @@ func outputDagnode(out chan interface{}, name string, dn node.Node) error {
572
return nil
573
}
574
575
+// NewMemoryDagService builds and returns a new mem-datastore.
576
func NewMemoryDagService() dag.DAGService {
577
// build mem-datastore for editor's intermediary nodes
578
bs := bstore.NewBlockstore(syncds.MutexWrap(ds.NewMapDatastore()))