cachedshell

Documentation

Overview

Package cachedshell adds some helpful caching functionality to the go-ipfs-api shell

Index

• type Shell
  • func NewShell(url string, c *cache.Cache) *Shell
  • func (s *Shell) AddPermanentFile(filename string) (string, error)
  • func (s *Shell) ClearPermanentFile(filename string)

Types

type Shell

type Shell struct {
	*shell.Shell
	Cache *cache.Cache
}

Shell embeds the go-ipfs-api shell with an extra *Cache

func NewShell

func NewShell(url string, c *cache.Cache) *Shell

NewShell takes the IPFS API url and an existing cache and returns a *Shell

func (*Shell) AddPermanentFile

func (s *Shell) AddPermanentFile(filename string) (string, error)

AddPermanentFile adds a file by its filename to IPFS returns the resulting object's hash. The hash is cached on a per-filename basis, so future calls to this method simply return the cached version of the hash for the same filename, assuming that the file has not changed.

func (*Shell) ClearPermanentFile

func (s *Shell) ClearPermanentFile(filename string)

ClearPermanentFile clears the cache value for the pernanent file hash previously added by AddPermanentFile.