opensource/kubo
1
0
Fork 0
mirror of https://github.com/ipfs/kubo.git synced 2025-06-17 08:33:44 +08:00
Code Issues Projects Releases Wiki Activity

coreapi: add more docs for path

Browse Source 
License: MIT
Signed-off-by: Łukasz Magiera <magik6k@gmail.com>
This commit is contained in:
Łukasz Magiera
2018-04-20 13:56:33 +02:00
parent 1d23bbeb0f
commit d5b5e0d7ac
1 changed files with 21 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
core/coreapi/interface/path.go
View File

@ -17,7 +17,9 @@ type Path interface {
// String returns the path as a string.
String() string
// Namespace returns the first component of the path
// Namespace returns the first component of the path.
//
// For example path "/ipfs/QmHash", calling Namespace() will return "ipfs"
Namespace() string
// Mutable returns false if the data pointed to by this path in guaranteed
@ -29,13 +31,29 @@ type Path interface {
// ResolvedPath is a resolved Path
type ResolvedPath interface {
// Cid returns the CID referred to by path
// Cid returns the CID of the object referenced by the path.
//
// Example:
// If you have 3 linked objects: QmRoot -> A -> B, and resolve path
// "/ipfs/QmRoot/A/B", the Cid method will return the CID of object B
Cid() *cid.Cid
// Root returns the CID of root path
// Root returns the CID of the root object of the path
//
// Example:
// If you have 3 linked objects: QmRoot -> A -> B, and resolve path
// "/ipfs/QmRoot/A/B", the Root method will return the CID of object QmRoot
Root() *cid.Cid
// Remainder returns unresolved part of the path
//
// Example:
// If you have 2 linked objects: QmRoot -> A, where A is a CBOR node
// containing the following data:
//
// {"foo": {"bar": 42}}
//
// When resolving "/ipld/QmRoot/A/foo/bar", Remainder will return "foo/bar"
Remainder() string
Path