rules

Documentation

Index

• func DefaultExcludes() []types.Rule
• func NewBinaryRule() types.Rule
• func NewExtensionRule(exts []string, action types.RuleAction) types.Rule
• func NewPatternRule(patterns []string, action types.RuleAction) types.Rule
• type BaseRule
  • func (r *BaseRule) Action() RuleAction
• type BinaryRule
  • func (r *BinaryRule) Match(path string) bool
• type ExtensionRule
  • func (r *ExtensionRule) Match(path string) bool
• type PatternRule
  • func (r *PatternRule) Match(path string) bool
  • func (r *PatternRule) Patterns() []string
• type Rule
• type RuleAction

Functions

func DefaultExcludes

func DefaultExcludes() []types.Rule

func NewBinaryRule

func NewBinaryRule() types.Rule

func NewExtensionRule

func NewExtensionRule(exts []string, action types.RuleAction) types.Rule

func NewPatternRule

func NewPatternRule(patterns []string, action types.RuleAction) types.Rule

Types

type BaseRule

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

BaseRule provides common functionality

func (*BaseRule) Action

func (r *BaseRule) Action() RuleAction

type BinaryRule

type BinaryRule struct {
	types.BaseRule
}

func (*BinaryRule) Match

func (r *BinaryRule) Match(path string) bool

Match checks if a file is binary using three methods: 1. Known binary file extensions 2. Presence of null bytes in the first 1024 bytes 3. UTF-8 validation of the content

type ExtensionRule

type ExtensionRule struct {
	types.BaseRule
	// contains filtered or unexported fields
}

func (*ExtensionRule) Match

func (r *ExtensionRule) Match(path string) bool

type PatternRule

type PatternRule struct {
	types.BaseRule
	// contains filtered or unexported fields
}

func (*PatternRule) Match

func (r *PatternRule) Match(path string) bool

func (*PatternRule) Patterns

func (r *PatternRule) Patterns() []string

type Rule

type Rule interface {
	Match(path string) bool
	Action() RuleAction
}

type RuleAction

type RuleAction int

const (
	Include RuleAction = iota
	Exclude
	Skip
)