globalsignal

Documentation

Index

• type Signal
  • func MustNewSignal(signal string) Signal
  • func NewSignal(signal string) (Signal, error)
  • func (s Signal) MarshalText() (text []byte, err error)
  • func (s Signal) String() string

Types

type Signal

type Signal struct {
	// contains filtered or unexported fields
}

Signal represents the signals supported by the collector.

func MustNewSignal

func MustNewSignal(signal string) Signal

MustNewSignal creates a Signal. It panics if the Signal is invalid. A signal must consist of 1 to 62 lowercase ASCII alphabetic characters.

func NewSignal

func NewSignal(signal string) (Signal, error)

NewSignal creates a Signal. It returns an error if the Signal is invalid. A Signal must consist of 1 to 62 lowercase ASCII alphabetic characters.

func (Signal) MarshalText

func (s Signal) MarshalText() (text []byte, err error)

MarshalText marshals the Signal.

func (Signal) String

func (s Signal) String() string

String returns the string representation of the signal.