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

interface docs for coreapi interface

Browse Source 
License: MIT
Signed-off-by: ForrestWeston <forrest@protocol.ai>


This commit was moved from ipfs/interface-go-ipfs-core@2c3137f055

This commit was moved from ipfs/boxo@4d4c3dc176
This commit is contained in:
ForrestWeston 2018-01-22 14:44:46 -08:00
parent ef926cb0e3
commit 4124018bc2
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
core/coreiface/interface.go
View File

@ -17,9 +17,13 @@ import (
// Path is a generic wrapper for paths used in the API. A path can be resolved
// to a CID using one of Resolve functions in the API.
type Path interface {
// String returns the path as a string.
String() string
// Cid returns cid referred to by path
Cid() *cid.Cid
// Root returns cid of root path
Root() *cid.Cid
// Resolved returns whether path has been fully resolved
Resolved() bool
}
@ -33,22 +37,31 @@ type Reader interface {
io.Closer
}
// IpnsEntry specifies the interface to IpnsEntries
type IpnsEntry interface {
// Name returns IpnsEntry name
Name() string
// Value returns IpnsEntry value
Value() Path
}
// Key specifies the interface to Keys in KeyAPI Keystore
type Key interface {
// Key returns key name
Name() string
// Path returns key path
Path() Path
}
// CoreAPI defines an unified interface to IPFS for Go programs.
type CoreAPI interface {
// Unixfs returns an implementation of Unixfs API
// Unixfs returns an implementation of Unixfs API.
Unixfs() UnixfsAPI
// Dag returns an implementation of Dag API.
Dag() DagAPI
// Name returns an implementation of Name API.
Name() NameAPI
// Key returns an implementation of Key API.
Key() KeyAPI
// ResolvePath resolves the path using Unixfs resolver