mode

package

v0.15.6 Latest Latest Go to latest Published: Jan 23, 2024 License: ISC Imports: 4 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

Package mode - simple module to record the global running mode

This section is empty.

This section is empty.

func ChainName() string

ChainName - name of the current chain

func Finalise() error

Finalise - shutdown mode handling

func Initialise(chainName string) error

Initialise - set up the mode system

func Is(mode Mode) bool

Is - detect mode

func IsNot(mode Mode) bool

IsNot - detect mode

func IsTesting() bool

IsTesting - special for testing

func Set(mode Mode)

Set - change mode

func String() string

String - current mode represented as a string

type Mode int

Mode - type to hold the mode

const (
	Stopped Mode = iota
	Resynchronise
	Normal
)

all possible modes

func (m Mode) String() string

String - current mode represented as a string