lib

Documentation

Index

• func ApiShell(ipfsDir string) (*api.Shell, string, error)
• func CurrentIpfsVersion() (string, error)
• func InstallBinaryTo(nbin, nloc string) error
• func SelectRevertBin() (string, error)
• func StashOldBinary(tag string, keep bool) (string, error)
• type Install
  • func NewInstall(target string, nocheck, downgrade bool, fetcher migrations.Fetcher) *Install
  • func (i *Install) Run(ctx context.Context) error
• type IpfsFetcher
  • func NewIpfsFetcher(distPath string, fetchLimit int64) *IpfsFetcher
  • func (f *IpfsFetcher) Close() error
  • func (f *IpfsFetcher) Fetch(ctx context.Context, filePath string) ([]byte, error)

Functions

func ApiShell

func ApiShell(ipfsDir string) (*api.Shell, string, error)

ApiShell creates a new ipfs api shell and checks that it is up. If the shell is available, then the shell and ipfs version are returned.

func CurrentIpfsVersion

func CurrentIpfsVersion() (string, error)

CurrentIpfsVersion returns the version of the currently running or installed ipfs executable.

func InstallBinaryTo

func InstallBinaryTo(nbin, nloc string) error

func SelectRevertBin

func SelectRevertBin() (string, error)

func StashOldBinary

func StashOldBinary(tag string, keep bool) (string, error)

StashOldBinary moves the existing ipfs binary to a backup directory and returns the path to the original location of the old binary

Types

type Install

type Install struct {
	// contains filtered or unexported fields
}

func NewInstall

func NewInstall(target string, nocheck, downgrade bool, fetcher migrations.Fetcher) *Install

func (*Install) Run

func (i *Install) Run(ctx context.Context) error

type IpfsFetcher

type IpfsFetcher struct {
	// contains filtered or unexported fields
}

func NewIpfsFetcher

func NewIpfsFetcher(distPath string, fetchLimit int64) *IpfsFetcher

NewIpfsFetcher creates a new IpfsFetcher

Specifying "" for distPath sets the default IPNS path. Specifying 0 for fetchLimit sets the default, -1 means no limit.

func (*IpfsFetcher) Close

func (f *IpfsFetcher) Close() error

func (*IpfsFetcher) Fetch

func (f *IpfsFetcher) Fetch(ctx context.Context, filePath string) ([]byte, error)

Fetch attempts to fetch the file at the given path, from the distribution site configured for this HttpFetcher. Returns io.ReadCloser on success, which caller must close.