shell

package module

Go to main page

Versions in this module

v0

v0.4.0

Jan 21, 2021

Changes in this version

+ var FilesChcid filesChcid

+ var FilesLs filesLs

+ var FilesMkdir filesMkdir

+ var FilesRead filesRead

+ var FilesStat filesStat

+ var FilesWrite filesWrite

+ var KeyGen keyGen

+ type FilesOpt func(*RequestBuilder) error

+ type FilesStatObject struct

+ Blocks int

+ CumulativeSize uint64

+ Hash string

+ Local bool

+ Size uint64

+ SizeLocal uint64

+ Type string

+ WithLocality bool

+ type Key struct

+ Id string

+ Name string

+ type KeyOpt func(*RequestBuilder) error

+ type KeyRenameObject struct

+ Id string

+ Now string

+ Overwrite bool

+ Was string

+ type MfsLsEntry struct

+ Hash string

+ Name string

+ Size uint64

+ Type uint8

type Shell

+ func (s *Shell) FilesChcid(ctx context.Context, path string, options ...FilesOpt) error

+ func (s *Shell) FilesCp(ctx context.Context, src string, dest string) error

+ func (s *Shell) FilesFlush(ctx context.Context, path string) (string, error)

+ func (s *Shell) FilesLs(ctx context.Context, path string, options ...FilesOpt) ([]*MfsLsEntry, error)

+ func (s *Shell) FilesMkdir(ctx context.Context, path string, options ...FilesOpt) error

+ func (s *Shell) FilesMv(ctx context.Context, src string, dest string) error

+ func (s *Shell) FilesRead(ctx context.Context, path string, options ...FilesOpt) (io.ReadCloser, error)

+ func (s *Shell) FilesRm(ctx context.Context, path string, force bool) error

+ func (s *Shell) FilesStat(ctx context.Context, path string, options ...FilesOpt) (*FilesStatObject, error)

+ func (s *Shell) FilesWrite(ctx context.Context, path string, data io.Reader, options ...FilesOpt) error

+ func (s *Shell) KeyGen(ctx context.Context, name string, options ...KeyOpt) (*Key, error)

+ func (s *Shell) KeyList(ctx context.Context) ([]*Key, error)

+ func (s *Shell) KeyRename(ctx context.Context, old string, new string, force bool) (*KeyRenameObject, error)

+ func (s *Shell) KeyRm(ctx context.Context, name string) ([]*Key, error)

v0.3.0

May 16, 2020

Changes in this version

+ type PinStreamInfo struct

+ Cid string

+ Type string

type Shell

+ func (s *Shell) PinsStream(ctx context.Context) (<-chan PinStreamInfo, error)

v0.2.2

Apr 22, 2020

Changes in this version

type Shell

+ func (s *Shell) StorageUploadSignGuardQuestions(id string, unsignedData *UnsignedData, uts string, sessionStatus string) error

+ func (s *Shell) StorageUploadSignWaitupload(id string, unsignedData *UnsignedData, uts string, sessionStatus string) error

v0.2.1

Mar 14, 2020

Changes in this version

+ func NewSessionSignature(hash string, peerIdStr string, uts string, verifyBefore bool) (string, error)

+ func VerifySessionSignature(offSignRenterPid peer.ID, data string, sessionSigStr string) error

v0.2.0

Mar 10, 2020

Changes in this version

type Shell

+ func (s *Shell) AddMultiPartFileDir(dir files.Directory, reedSolomon bool) (string, error)

+ func (s *Shell) AddSerialFileDir(dir string, reedSolomon bool) (string, error)

+ func (s *Shell) AddSlicedDirectory(dir files.Directory, reedSolomon bool) (string, error)

v0.1.7

Mar 6, 2020

Changes in this version

+ type ContractItem struct

+ Contract string

+ Key string

+ type Contracts struct

+ Contracts []ContractItem

+ func (c Contracts) SignContracts(privateKey string, sessionStatus string) (*Contracts, error)

+ type Shard struct

+ ContractId string

+ Host string

+ Price int64

+ Status string

type Shell

+ func (s *Shell) GetUts() string

+ func (s *Shell) StorageUploadGetContractBatch(sid string, hash string, uts string, sessionStatus string) (*Contracts, error)

+ func (s *Shell) StorageUploadGetUnsignedData(sid string, hash string, uts string, sessionStatus string) (*UnsignedData, error)

+ func (s *Shell) StorageUploadOffSign(hash string, uts string, options ...StorageUploadOpts) (string, error)

+ func (s *Shell) StorageUploadSign(id string, hash string, unsignedData *UnsignedData, uts string, ...) ([]byte, error)

+ func (s *Shell) StorageUploadSignBalance(id string, hash string, unsignedData *UnsignedData, uts string, ...) error

+ func (s *Shell) StorageUploadSignBatch(sid string, hash string, unsignedBatchContracts *Contracts, uts string, ...) error

+ func (s *Shell) StorageUploadSignGuardFileMeta(id, hash string, unsignedData *UnsignedData, uts string, sessionStatus string) error

+ func (s *Shell) StorageUploadSignPayChannel(id, hash string, unsignedData *UnsignedData, uts string, sessionStatus string, ...) error

+ func (s *Shell) StorageUploadSignPayRequest(id, hash string, unsignedData *UnsignedData, uts string, sessionStatus string) error

+ type StorageOpts = func(*RequestBuilder) error

+ func Hosts(hosts string) StorageOpts

+ func UploadMode(mode string) StorageOpts

+ type UnsignedData struct

+ Opcode string

+ Price int64

+ Unsigned string

+ func (d UnsignedData) SignBalanceData(privateKey string) (*ledgerpb.SignedPublicKey, error)

+ func (d UnsignedData) SignData(privateKey string) ([]byte, error)

v0.1.6

Jan 19, 2020

v0.1.5

Jan 15, 2020

Changes in this version

type Storage

+ Message string

+ type StorageUploadOpts = func(*RequestBuilder) error

+ func StorageLength(length int) StorageUploadOpts

v0.1.4

Dec 20, 2019

Changes in this version

type Shell

+ func (s *Shell) Remove(hash string) bool

+ func (s *Shell) StorageUpload(hash string) (string, error)

+ func (s *Shell) StorageUploadStatus(id string) (Storage, error)

+ type Storage struct

+ FileHash string

+ Shards map[string]shard

+ Status string

v0.1.3

Dec 19, 2019

Changes in this version

type AddOpts

+ func Chunker(chunker string) AddOpts

v0.1.2

Dec 19, 2019

v0.1.1

Dec 3, 2019

Changes in this version

type AddOpts

+ func CidVersion(version int) AddOpts

+ func Hash(hash string) AddOpts

+ func Meta(meta string) AddOpts

+ type Logger struct

+ func (l Logger) Close() error

+ func (l Logger) Next() (map[string]interface{}, error)

type Request

+ Ctx context.Context

type Shell

+ func (s *Shell) GetLogs(ctx context.Context) (Logger, error)

v0.1.0

Nov 19, 2019

Changes in this version

+ const API_VERSION

+ const DefaultApiFile

+ const DefaultPathName

+ const DefaultPathRoot

+ const DirectPin

+ const EnvDir

+ const IndirectPin

+ const RecursivePin

+ const TDirectory

+ const TFile

+ const TMetadata

+ const TRaw

+ const TSymlink

+ type AddOpts = func(*RequestBuilder) error

+ func OnlyHash(enabled bool) AddOpts

+ func Pin(enabled bool) AddOpts

+ func Progress(enabled bool) AddOpts

+ func RawLeaves(enabled bool) AddOpts

+ type Error struct

+ Code int

+ Command string

+ Message string

+ func (e *Error) Error() string

+ type IdOutput struct

+ Addresses []string

+ AgentVersion string

+ ID string

+ ProtocolVersion string

+ PublicKey string

+ type IpfsObject struct

+ Data string

+ Links []ObjectLink

+ type LsLink struct

+ Hash string

+ Name string

+ Size uint64

+ Type int

+ type LsObject struct

+ Links []*LsLink

+ type Message struct

+ Data []byte

+ From peer.ID

+ Seqno []byte

+ TopicIDs []string

+ type ObjectLink struct

+ Hash string

+ Name string

+ Size uint64

+ type ObjectStats struct

+ BlockSize int

+ CumulativeSize int

+ DataSize int

+ Hash string

+ LinksSize int

+ NumLinks int

+ type PeerInfo struct

+ Addrs []string

+ ID string

+ type PeersList struct

+ Peers []string

+ type PinInfo struct

+ Type string

+ type PubSubSubscription struct

+ func (s *PubSubSubscription) Cancel() error

+ func (s *PubSubSubscription) Next() (*Message, error)

+ type PublishResponse struct

+ Name string

+ Value string

+ type Request struct

+ ApiBase string

+ Args []string

+ Body io.Reader

+ Command string

+ Headers map[string]string

+ Opts map[string]string

+ func NewRequest(ctx context.Context, url, command string, args ...string) *Request

+ func (r *Request) Send(c *http.Client) (*Response, error)

+ type RequestBuilder struct

+ func (r *RequestBuilder) Arguments(args ...string) *RequestBuilder

+ func (r *RequestBuilder) Body(body io.Reader) *RequestBuilder

+ func (r *RequestBuilder) BodyBytes(body []byte) *RequestBuilder

+ func (r *RequestBuilder) BodyString(body string) *RequestBuilder

+ func (r *RequestBuilder) Exec(ctx context.Context, res interface{}) error

+ func (r *RequestBuilder) Header(name, value string) *RequestBuilder

+ func (r *RequestBuilder) Option(key string, value interface{}) *RequestBuilder

+ func (r *RequestBuilder) Send(ctx context.Context) (*Response, error)

+ type Response struct

+ Error *Error

+ Output io.ReadCloser

+ func (r *Response) Close() error

+ func (r *Response) Decode(dec interface{}) error

+ type Shell struct

+ func NewLocalShell() *Shell

+ func NewShell(url string) *Shell

+ func NewShellWithClient(url string, c *gohttp.Client) *Shell

+ func (s *Shell) Add(r io.Reader, options ...AddOpts) (string, error)

+ func (s *Shell) AddDir(dir string) (string, error)

+ func (s *Shell) AddLink(target string) (string, error)

+ func (s *Shell) AddNoPin(r io.Reader) (string, error)

+ func (s *Shell) AddWithOpts(r io.Reader, pin bool, rawLeaves bool) (string, error)

+ func (s *Shell) BlockGet(path string) ([]byte, error)

+ func (s *Shell) BlockPut(block []byte, format, mhtype string, mhlen int) (string, error)

+ func (s *Shell) BlockStat(path string) (string, int, error)

+ func (s *Shell) BootstrapAdd(peers []string) ([]string, error)

+ func (s *Shell) BootstrapAddDefault() ([]string, error)

+ func (s *Shell) BootstrapRmAll() ([]string, error)

+ func (s *Shell) Cat(path string) (io.ReadCloser, error)

+ func (s *Shell) DagGet(ref string, out interface{}) error

+ func (s *Shell) DagPut(data interface{}, ienc, kind string) (string, error)

+ func (s *Shell) DagPutWithOpts(data interface{}, opts ...options.DagPutOption) (string, error)

+ func (s *Shell) FileList(path string) (*UnixLsObject, error)

+ func (s *Shell) FindPeer(peer string) (*PeerInfo, error)

+ func (s *Shell) Get(hash, outdir string) error

+ func (s *Shell) ID(peer ...string) (*IdOutput, error)

+ func (s *Shell) IsUp() bool

+ func (s *Shell) List(path string) ([]*LsLink, error)

+ func (s *Shell) NewObject(template string) (string, error)

+ func (s *Shell) ObjectGet(path string) (*IpfsObject, error)

+ func (s *Shell) ObjectPut(obj *IpfsObject) (string, error)

+ func (s *Shell) ObjectStat(key string) (*ObjectStats, error)

+ func (s *Shell) Patch(root, action string, args ...string) (string, error)

+ func (s *Shell) PatchData(root string, set bool, data interface{}) (string, error)

+ func (s *Shell) PatchLink(root, path, childhash string, create bool) (string, error)

+ func (s *Shell) Pin(path string) error

+ func (s *Shell) Pins() (map[string]PinInfo, error)

+ func (s *Shell) PubSubPublish(topic, data string) (err error)

+ func (s *Shell) PubSubSubscribe(topic string) (*PubSubSubscription, error)

+ func (s *Shell) Publish(node string, value string) error

+ func (s *Shell) PublishWithDetails(contentHash, key string, lifetime, ttl time.Duration, resolve bool) (*PublishResponse, error)

+ func (s *Shell) Refs(hash string, recursive bool) (<-chan string, error)

+ func (s *Shell) Request(command string, args ...string) *RequestBuilder

+ func (s *Shell) Resolve(id string) (string, error)

+ func (s *Shell) ResolvePath(path string) (string, error)

+ func (s *Shell) SetTimeout(d time.Duration)

+ func (s *Shell) StatsBW(ctx context.Context) (*p2pmetrics.Stats, error)

+ func (s *Shell) SwarmConnect(ctx context.Context, addr ...string) error

+ func (s *Shell) SwarmPeers(ctx context.Context) (*SwarmConnInfos, error)

+ func (s *Shell) Unpin(path string) error

+ func (s *Shell) Version() (string, string, error)

+ type SwarmConnInfo struct

+ Addr string

+ Latency string

+ Muxer string

+ Peer string

+ Streams []SwarmStreamInfo

+ type SwarmConnInfos struct

+ Peers []SwarmConnInfo

+ type SwarmStreamInfo struct

+ Protocol string

+ type UnixLsLink struct

+ Hash string

+ Name string

+ Size uint64

+ Type string

+ type UnixLsObject struct

+ Hash string

+ Links []*UnixLsLink

+ Size uint64

+ Type string

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL