plugin

Documentation

Index

• type Plugin
• type PluginDatastore
• type PluginIPLD
• type PluginTracer

Types

type Plugin

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
	Init() error
}

Plugin is base interface for all kinds of go-ipfs plugins It will be included in interfaces of different Plugins

type PluginDatastore

type PluginDatastore interface {
	Plugin

	DatastoreTypeName() string
	DatastoreConfigParser() fsrepo.ConfigFromMap
}

PluginDatastore is an interface that can be implemented to add handlers for for different datastores

type PluginIPLD

type PluginIPLD interface {
	Plugin

	RegisterBlockDecoders(dec ipld.BlockDecoder) error
	RegisterInputEncParsers(iec coredag.InputEncParsers) error
}

PluginIPLD is an interface that can be implemented to add handlers for for different IPLD formats

type PluginTracer

type PluginTracer interface {
	Plugin
	InitTracer() (opentracing.Tracer, error)
}

PluginTracer is an interface that can be implemented to add a tracer