plugins

package module

v0.1.1-0...-3a92c13 Latest Latest Go to latest Published: Aug 22, 2022 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/gohugoio/hugoreleaser

Documentation ¶

Index ¶

Constants
func FromMap[T any](m map[string]any) (T, error)
type Dispatcher
type Error
- func NewError(what string, err error) *Error
- func (r Error) Error() string
type Heartbeater
type Server
- func NewServer[Q Heartbeater[R], R any](call func(Dispatcher, Q) R) (*Server[Q, R], error)

Constants ¶

View Source

const StatusInfoLog = 101

StatusInfoLog is used to mark a INFO log message from the server.

Variables ¶

This section is empty.

Functions ¶

func FromMap ¶

func FromMap[T any](m map[string]any) (T, error)

FromNMap converts m to T. See https://pkg.go.dev/github.com/mitchellh/mapstructure#section-readme

Types ¶

type Dispatcher ¶

type Dispatcher interface {
	Infof(format string, args ...interface{})
}

type Error ¶

type Error struct {
	Msg string `toml:"msg"`
}

Error holds an error message.

func NewError ¶

func NewError(what string, err error) *Error

Error is an error that can be returned from a plugin, it's main quality is that it can be marshalled to and from TOML/JSON etc.

func (Error) Error ¶

func (r Error) Error() string

type Heartbeater ¶

type Heartbeater[R any] interface {
	HeartbeatResponse() (R, bool)
}

type Server ¶

type Server[Q, R any] struct {
	*execrpc.Server[Q, R]
}

func NewServer ¶

func NewServer[Q Heartbeater[R], R any](call func(Dispatcher, Q) R) (*Server[Q, R], error)

NewServer creates a new server which will call the given function with a request Q. The Dispatcher an be used for logging. Any errors needs to be sent in R.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
archiveplugin
archiveplugins
deb Module
model

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL