act

package
v1.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Feb 7, 2026 License: AGPL-3.0 Imports: 25 Imported by: 0

Documentation

Index

Constants

View Source
const (
	VerbAlert      string = "alert"
	VerbQuarantine string = "quarantine"
	VerbExile      string = "exile"
	VerbClean      string = "clean"
)

Verbs store verb:acter.

Variables

View Source
var (
	// ErrAlerterLoad means alerter load err.
	ErrAlerterLoad = errors.New("act: alerter load error")

	// ErrAlertSend means alert send err.
	ErrAlertSend = errors.New("act: alert send error")
)

ALERTS

View Source
var (
	// ErrQuarantineNoDir means no quarantine dir.
	ErrQuarantineNoDir = errors.New("act: no quarantine dir configured in cfg/actions.toml")

	// ErrQuarantineMv means hit mv err.
	ErrQuarantineMv = errors.New("act: move hit error")
)

QUARANTINES

View Source
var (
	// ErrCleanNoExpr means no expr for match.
	ErrCleanNoExpr = errors.New("act: no clean expressions for match")

	// ErrCleanFailed means still hits after clean.
	ErrCleanFailed = errors.New("act: clean failed")
)

CLEANS

View Source
var (
	// ErrExileNoRegion means no region configured.
	ErrExileNoRegion = errors.New("act: no region configured for exile")

	// ErrExileUpload means upload err.
	ErrExileUpload = errors.New("act: exile upload error")

	// ErrExileDelErr means del err.
	ErrExileDelErr = errors.New("act: exile del error")
)

EXILES

View Source
var (
	// ErrCfgLoad means cfg load error.
	ErrCfgLoad = errors.New("act: cfg load error")
)

Functions

func Preset added in v1.2.0

func Preset(env *env.Env) []acter.Acter

Preset returns preset acts for given env.

Types

type Alerter

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

Alerter represents alerting.

func NewAlerter

func NewAlerter(env *env.Env) *Alerter

NewAlerter returns alerter for given env.

func (*Alerter) Act

func (alerter *Alerter) Act(result *state.Result) error

Act sends alerts for given result.

func (*Alerter) Load

func (alerter *Alerter) Load() error

Load loads given alerter.

func (*Alerter) Verb

func (alerter *Alerter) Verb() string

Verb returns a given alerter verb.

type Cleaner

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

Cleaner represents cleaning.

func NewCleaner

func NewCleaner(env *env.Env) *Cleaner

NewCleaner returns cleaner for given env.

func (*Cleaner) Act

func (cleaner *Cleaner) Act(result *state.Result) error

Act cleans hits for given result.

func (*Cleaner) Load

func (cleaner *Cleaner) Load() error

Load loads given cleaner.

func (*Cleaner) Verb

func (cleaner *Cleaner) Verb() string

Verb returns a given cleaner verb.

type Exiler

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

Exiler represents an acter for exiles.

func NewExiler

func NewExiler(env *env.Env) *Exiler

NewExiler returns exiler for given env.

func (*Exiler) Act

func (exiler *Exiler) Act(result *state.Result) error

Act exiles hits from a given result.

func (*Exiler) Load

func (exiler *Exiler) Load() error

Load loads a given exiler.

func (*Exiler) Verb

func (exiler *Exiler) Verb() string

Verb returns a given exiler verb.

type Quarantiner

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

Quarantiner represents quarantines.

func NewQuarantiner

func NewQuarantiner(env *env.Env) *Quarantiner

NewQuarantiner returns quarantiner for given env.

func (*Quarantiner) Act

func (quarantiner *Quarantiner) Act(result *state.Result) error

Act quarantines hits for given result.

func (*Quarantiner) Load

func (quarantiner *Quarantiner) Load() error

Load loads a given quarantiner.

func (*Quarantiner) Verb

func (quarantiner *Quarantiner) Verb() string

Verb returns a given quarantiner verb.

Jump to

Keyboard shortcuts

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