mirror of
https://github.com/ipfs/kubo.git
synced 2025-05-23 01:46:53 +08:00
ee45b8d32f
The new coreiface.Path maps a path to the cid.Cid resulting from a full path resolution. The path is internally represented as a go-ipfs/path.Path, but that doesn't matter to the outside. Apart from the path-to-CID mapping, it also aims to hold all resolved segment CIDs of the path. Right now it only exposes Root(), and only for flat paths a la /ipfs/Qmfoo. In other cases, the root is nil. In the future, resolution will internally use go-ipfs/path.Resolver.ResolvePathComponents and thus always return the proper resolved segments, via Root(), or a future Segments() func. - Add coreiface.Path with Cid() and Root(). - Add CoreAPI.ResolvePath() for getting a coreiface.Path. - All functions now expect and return coreiface.Path. - Add ParsePath() and ParseCid() for constructing a coreiface.Path. - Add coreiface.Node and Link which are simply go-ipld-node.Node and Link. - Add CoreAPI.ResolveNode() for getting a Node from a Path. License: MIT Signed-off-by: Lars Gierth <larsg@systemli.org>
65 lines
1.5 KiB
Go
65 lines
1.5 KiB
Go
package iface
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"io"
|
|
|
|
cid "gx/ipfs/QmV5gPoRsjN1Gid3LMdNZTyfCtP2DsvqEbMAmz82RmmiGk/go-cid"
|
|
ipld "gx/ipfs/QmYDscK7dmdo2GZ9aumS8s5auUUAH5mR1jvj5pYhWusfK7/go-ipld-node"
|
|
)
|
|
|
|
type Path interface {
|
|
String() string
|
|
Cid() *cid.Cid
|
|
Root() *cid.Cid
|
|
Resolved() bool
|
|
}
|
|
|
|
// TODO: should we really copy these?
|
|
// if we didn't, godoc would generate nice links straight to go-ipld-node
|
|
type Node ipld.Node
|
|
type Link ipld.Link
|
|
|
|
type Reader interface {
|
|
io.ReadSeeker
|
|
io.Closer
|
|
}
|
|
|
|
type CoreAPI interface {
|
|
Unixfs() UnixfsAPI
|
|
ResolvePath(context.Context, Path) (Path, error)
|
|
ResolveNode(context.Context, Path) (Node, error)
|
|
}
|
|
|
|
type UnixfsAPI interface {
|
|
Add(context.Context, io.Reader) (Path, error)
|
|
Cat(context.Context, Path) (Reader, error)
|
|
Ls(context.Context, Path) ([]*Link, error)
|
|
}
|
|
|
|
// type ObjectAPI interface {
|
|
// New() (cid.Cid, Object)
|
|
// Get(string) (Object, error)
|
|
// Links(string) ([]*Link, error)
|
|
// Data(string) (Reader, error)
|
|
// Stat(string) (ObjectStat, error)
|
|
// Put(Object) (cid.Cid, error)
|
|
// SetData(string, Reader) (cid.Cid, error)
|
|
// AppendData(string, Data) (cid.Cid, error)
|
|
// AddLink(string, string, string) (cid.Cid, error)
|
|
// RmLink(string, string) (cid.Cid, error)
|
|
// }
|
|
|
|
// type ObjectStat struct {
|
|
// Cid cid.Cid
|
|
// NumLinks int
|
|
// BlockSize int
|
|
// LinksSize int
|
|
// DataSize int
|
|
// CumulativeSize int
|
|
// }
|
|
|
|
var ErrIsDir = errors.New("object is a directory")
|
|
var ErrOffline = errors.New("can't resolve, ipfs node is offline")
|