repo

Documentation

Index

• Variables
• type Datastore
• type Mock
  • func (m *Mock) BackupConfig(prefix string) (string, error)
  • func (m *Mock) Close() error
  • func (m *Mock) Config() (*config.Config, error)
  • func (m *Mock) Datastore() Datastore
  • func (m *Mock) FileManager() *filestore.FileManager
  • func (m *Mock) GetConfigKey(key string) (interface{}, error)
  • func (m *Mock) GetStorageUsage(_ context.Context) (uint64, error)
  • func (m *Mock) Keystore() keystore.Keystore
  • func (m *Mock) Path() string
  • func (m *Mock) SetAPIAddr(addr ma.Multiaddr) error
  • func (m *Mock) SetConfig(updated *config.Config) error
  • func (m *Mock) SetConfigKey(key string, value interface{}) error
  • func (m *Mock) SetGatewayAddr(addr net.Addr) error
  • func (m *Mock) SwarmKey() ([]byte, error)
  • func (m *Mock) UserResourceOverrides() (rcmgr.PartialLimitConfig, error)
• type OnlyOne
  • func (o *OnlyOne) Open(key interface{}, open func() (Repo, error)) (Repo, error)
• type Repo

Variables

var ErrApiNotRunning = errors.New("api not running") //nolint

Types

type Datastore

type Datastore interface {
	ds.Batching // must be thread-safe
}

Datastore is the interface required from a datastore to be acceptable to FSRepo.

type Mock

type Mock struct {
	C config.Config
	D Datastore
	K keystore.Keystore
	F *filestore.FileManager
}

Mock is not thread-safe.

func (*Mock) BackupConfig

func (m *Mock) BackupConfig(prefix string) (string, error)

func (*Mock) Close

func (m *Mock) Close() error

func (*Mock) Config

func (m *Mock) Config() (*config.Config, error)

func (*Mock) Datastore

func (m *Mock) Datastore() Datastore

func (*Mock) FileManager

func (m *Mock) FileManager() *filestore.FileManager

func (*Mock) GetConfigKey

func (m *Mock) GetConfigKey(key string) (interface{}, error)

func (*Mock) GetStorageUsage

func (m *Mock) GetStorageUsage(_ context.Context) (uint64, error)

func (*Mock) Keystore

func (m *Mock) Keystore() keystore.Keystore

func (*Mock) Path

func (m *Mock) Path() string

func (*Mock) SetAPIAddr

func (m *Mock) SetAPIAddr(addr ma.Multiaddr) error

func (*Mock) SetConfig

func (m *Mock) SetConfig(updated *config.Config) error

func (*Mock) SetConfigKey

func (m *Mock) SetConfigKey(key string, value interface{}) error

func (*Mock) SetGatewayAddr

func (m *Mock) SetGatewayAddr(addr net.Addr) error

func (*Mock) SwarmKey

func (m *Mock) SwarmKey() ([]byte, error)

func (*Mock) UserResourceOverrides

func (m *Mock) UserResourceOverrides() (rcmgr.PartialLimitConfig, error)

type OnlyOne

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

OnlyOne tracks open Repos by arbitrary key and returns the already open one.

func (*OnlyOne) Open

func (o *OnlyOne) Open(key interface{}, open func() (Repo, error)) (Repo, error)

Open a Repo identified by key. If Repo is not already open, the open function is called, and the result is remembered for further use.

Key must be comparable, or Open will panic. Make sure to pick keys that are unique across different concrete Repo implementations, e.g. by creating a local type:

type repoKey string
r, err := o.Open(repoKey(path), open)

Call Repo.Close when done.

type Repo

type Repo interface {
	// Config returns the ipfs configuration file from the repo. Changes made
	// to the returned config are not automatically persisted.
	Config() (*config.Config, error)

	// Path is the repo file-system path
	Path() string

	// UserResourceOverrides returns optional user resource overrides for the
	// libp2p resource manager.
	UserResourceOverrides() (rcmgr.PartialLimitConfig, error)

	// BackupConfig creates a backup of the current configuration file using
	// the given prefix for naming.
	BackupConfig(prefix string) (string, error)

	// SetConfig persists the given configuration struct to storage.
	SetConfig(*config.Config) error

	// SetConfigKey sets the given key-value pair within the config and persists it to storage.
	SetConfigKey(key string, value interface{}) error

	// GetConfigKey reads the value for the given key from the configuration in storage.
	GetConfigKey(key string) (interface{}, error)

	// Datastore returns a reference to the configured data storage backend.
	Datastore() Datastore

	// GetStorageUsage returns the number of bytes stored.
	GetStorageUsage(context.Context) (uint64, error)

	// Keystore returns a reference to the key management interface.
	Keystore() keystore.Keystore

	// FileManager returns a reference to the filestore file manager.
	FileManager() *filestore.FileManager

	// SetAPIAddr sets the API address in the repo.
	SetAPIAddr(addr ma.Multiaddr) error

	// SetGatewayAddr sets the Gateway address in the repo.
	SetGatewayAddr(addr net.Addr) error

	// SwarmKey returns the configured shared symmetric key for the private networks feature.
	SwarmKey() ([]byte, error)

	io.Closer
}

Repo represents all persistent data of a given ipfs node.