mirror of
https://github.com/ipfs/kubo.git
synced 2025-08-06 19:44:01 +08:00
d40a54caaf
(and everything else...) License: MIT Signed-off-by: Łukasz Magiera <magik6k@gmail.com> This commit was moved from ipfs/interface-go-ipfs-core@3cc6578657 This commit was moved from ipfs/boxo@99fe5e7502
36 lines
1.1 KiB
Go
36 lines
1.1 KiB
Go
package iface
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/ipfs/go-ipfs/core/coreapi/interface/options"
|
|
|
|
ipld "gx/ipfs/QmRL22E4paat7ky7vx9MLpR97JHHbFPrg3ytFQw6qp1y1s/go-ipld-format"
|
|
files "gx/ipfs/QmXWZCd8jfaHmt4UDSnjKmGcrQMw95bDGWqEeVLVJjoANX/go-ipfs-files"
|
|
)
|
|
|
|
type AddEvent struct {
|
|
Name string
|
|
Path ResolvedPath `json:",omitempty"`
|
|
Bytes int64 `json:",omitempty"`
|
|
Size string `json:",omitempty"`
|
|
}
|
|
|
|
// UnixfsAPI is the basic interface to immutable files in IPFS
|
|
// NOTE: This API is heavily WIP, things are guaranteed to break frequently
|
|
type UnixfsAPI interface {
|
|
// Add imports the data from the reader into merkledag file
|
|
//
|
|
// TODO: a long useful comment on how to use this for many different scenarios
|
|
Add(context.Context, files.Node, ...options.UnixfsAddOption) (ResolvedPath, error)
|
|
|
|
// Get returns a read-only handle to a file tree referenced by a path
|
|
//
|
|
// Note that some implementations of this API may apply the specified context
|
|
// to operations performed on the returned file
|
|
Get(context.Context, Path) (files.Node, error)
|
|
|
|
// Ls returns the list of links in a directory
|
|
Ls(context.Context, Path) ([]*ipld.Link, error)
|
|
}
|