-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathplugin.go
33 lines (28 loc) · 1.06 KB
/
plugin.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
package plugin
// Environment is the environment passed into the plugin on init.
type Environment struct {
// Path to the IPFS repo.
Repo string
// The plugin's config, if specified in the
// Plugins.Plugins["plugin-name"].Config field of the user's go-ipfs
// config. See docs/plugins.md for details.
//
// This is an arbitrary JSON-like object unmarshaled into an interface{}
// according to https://golang.org/pkg/encoding/json/#Unmarshal.
Config interface{}
}
// Plugin is the base interface for all kinds of go-ipfs plugins
// It will be included in interfaces of different Plugins
//
// Optionally, Plugins can implement io.Closer if they want to
// have a termination step when unloading.
type Plugin interface {
// Name should return unique name of the plugin
Name() string
// Version returns current version of the plugin
Version() string
// Init is called once when the Plugin is being loaded
// The plugin is passed an environment containing the path to the
// (possibly uninitialized) IPFS repo and the plugin's config.
Init(env *Environment) error
}