ignore

Documentation

Index

• Constants
• Variables
• func IsInternal(file string) bool
• func IsTemporary(name string) bool
• func TempName(name string) string
• func WriteIgnores(path string, content []string) error
• type Matcher
  • func New(withCache bool) *Matcher
  • func (m *Matcher) Hash() string
  • func (m *Matcher) Lines() []string
  • func (m *Matcher) Load(file string) error
  • func (m *Matcher) Match(file string) (result Result)
  • func (m *Matcher) Parse(r io.Reader, file string) error
  • func (m *Matcher) Patterns() []string
  • func (m *Matcher) ShouldIgnore(filename string) bool
  • func (m *Matcher) Stop()
• type Pattern
  • func (p Pattern) String() string
• type Result
  • func (r Result) IsCaseFolded() bool
  • func (r Result) IsDeletable() bool
  • func (r Result) IsIgnored() bool

Constants

const (
	WindowsTempPrefix = "~syncthing~"
	UnixTempPrefix    = ".syncthing."
)

Variables

var TempPrefix string

Functions

func IsInternal

func IsInternal(file string) bool

IsInternal returns true if the file, as a path relative to the folder root, represents an internal file that should always be ignored. The file path must be clean (i.e., in canonical shortest form).

func IsTemporary

func IsTemporary(name string) bool

IsTemporary is true if the file name has the temporary prefix. Regardless of the normally used prefix, the standard Windows and Unix temp prefixes are always recognized as temp files.

func TempName

func TempName(name string) string

func WriteIgnores

func WriteIgnores(path string, content []string) error

WriteIgnores is a convenience function to avoid code duplication

Types

type Matcher

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

func New

func New(withCache bool) *Matcher

func (*Matcher) Hash

func (m *Matcher) Hash() string

func (*Matcher) Lines

func (m *Matcher) Lines() []string

Lines return a list of the unprocessed lines in .stignore at last load

func (*Matcher) Load

func (m *Matcher) Load(file string) error

func (*Matcher) Match

func (m *Matcher) Match(file string) (result Result)

func (*Matcher) Parse

func (m *Matcher) Parse(r io.Reader, file string) error

func (*Matcher) Patterns

func (m *Matcher) Patterns() []string

Patterns return a list of the loaded patterns, as they've been parsed

func (*Matcher) ShouldIgnore

func (m *Matcher) ShouldIgnore(filename string) bool

ShouldIgnore returns true when a file is temporary, internal or ignored

func (*Matcher) Stop

func (m *Matcher) Stop()

type Pattern

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

func (Pattern) String

func (p Pattern) String() string

type Result

type Result uint8

func (Result) IsCaseFolded

func (r Result) IsCaseFolded() bool

func (Result) IsDeletable

func (r Result) IsDeletable() bool

func (Result) IsIgnored

func (r Result) IsIgnored() bool