add RootPath docs

ipfs · Dec 11, 2019 · 0167805 · 0167805
1 parent 76d7d79
commit 0167805
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 0 deletions.
diff --git a/plugin/plugins/filesystem/meta/meta_test.go b/plugin/plugins/filesystem/meta/meta_test.go
@@ -0,0 +1,8 @@
+package meta
+
+import corepath "github.com/ipfs/interface-go-ipfs-core/path"
+
+func ExampleRootPath() {
+	VirtualRootCid := RootPath("/ipfs").Cid()
+	iPath := corepath.Join(RootPath("/ipfs"), "Qm...")
+}
diff --git a/plugin/plugins/filesystem/meta/utils.go b/plugin/plugins/filesystem/meta/utils.go
@@ -112,6 +112,7 @@ func IpldStat(ctx context.Context, attr *p9.Attr, node ipld.Node, mask p9.AttrMa
 	return filledAttrs, nil
 }
 
+// RootPath wraps a namespace string path as a CoreAPI compatible path
 type RootPath string
 
 func (rp RootPath) String() string { return string(rp) }