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) 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) SwarmKey() ([]byte, error)
- type OnlyOne
- type Repo
Constants ¶
This section is empty.
Variables ¶
View Source
var (
ErrApiNotRunning = errors.New("api not running")
)
Functions ¶
This section is empty.
Types ¶
type Datastore ¶ added in v0.4.0
Datastore is the interface required from a datastore to be acceptable to FSRepo.
type Mock ¶
Mock is not thread-safe
func (*Mock) BackupConfig ¶ added in v0.4.14
func (*Mock) FileManager ¶ added in v0.4.7
func (m *Mock) FileManager() *filestore.FileManager
func (*Mock) GetConfigKey ¶
func (*Mock) GetStorageUsage ¶ added in v0.3.10
func (*Mock) SetConfigKey ¶
type OnlyOne ¶ added in v0.3.2
type OnlyOne struct {
// contains filtered or unexported fields
}
OnlyOne tracks open Repos by arbitrary key and returns the already open one.
func (*OnlyOne) Open ¶ added in v0.3.2
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) // 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 // 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.
Directories
¶
Path | Synopsis |
---|---|
package fsrepo TODO explain the package roadmap...
|
package fsrepo TODO explain the package roadmap... |
Click to show internal directories.
Click to hide internal directories.