alg

Documentation

Index

• type Factory
• type Parameter
• type Processor

Types

type Factory

type Factory func([]*Parameter) Processor

Factory for creating processor

type Parameter

type Parameter struct {
	// Evaluator for the rule
	Evaluator rule.Evaluator

	// Selectors for the rule
	Selectors []selector.Selector

	// Performer for the rule evaluator
	Performer action.Performer
}

Parameter for constructing a processor Represents one rule

type Processor

type Processor interface {
	// Process the artifact candidates
	//
	//  Arguments:
	//    artifacts []*art.Candidate : process the retention candidates
	//
	//  Returns:
	//    []*art.Result : the processed results
	//    error         : common error object if any errors occurred
	Process(ctx context.Context, artifacts []*selector.Candidate) ([]*selector.Result, error)
}

Processor processing the whole policy targeting a repository. Methods are defined to reflect the standard structure of the policy: list of rules with corresponding selectors plus an action performer.