ignoreresult

Documentation

Overview

Package result provides the result type for ignore matching. This is a separate package in order to break import cycles.

Index

• Constants
• type R
  • func (r R) CanSkipDir() bool
  • func (r R) IsCaseFolded() bool
  • func (r R) IsDeletable() bool
  • func (r R) IsIgnored() bool
  • func (r R) String() string
  • func (r R) ToggleIgnored() R
  • func (r R) WithDeletable() R
  • func (r R) WithFoldCase() R
  • func (r R) WithSkipDir() R

Constants

const (
	NotIgnored R = 0
	// `Ignored` is defined in platform specific files
	IgnoredDeletable = Ignored | deletableBit
	IgnoreAndSkip    = Ignored | canSkipDirBit
)

const Ignored = ignoreBit

Types

type R

type R uint8

func (R) CanSkipDir

func (r R) CanSkipDir() bool

CanSkipDir returns true if the result is ignored and the directory can be skipped (no need to recurse deeper). Note that ignore matches are textual and based on the name only -- this being true does not mean that the matched item is a directory, merely that *if* it is a directory, it can be skipped.

func (R) IsCaseFolded

func (r R) IsCaseFolded() bool

IsCaseFolded returns true if the result was a case-insensitive match.

func (R) IsDeletable

func (r R) IsDeletable() bool

IsDeletable returns true if the result is ignored and deletable.

func (R) IsIgnored

func (r R) IsIgnored() bool

IsIgnored returns true if the result is ignored.

func (R) String

func (r R) String() string

String returns a human readable representation of the result flags.

func (R) ToggleIgnored

func (r R) ToggleIgnored() R

ToggleIgnored returns a copy of the result with the ignored bit toggled.

func (R) WithDeletable

func (r R) WithDeletable() R

WithDeletable returns a copy of the result with the deletable bit set.

func (R) WithFoldCase

func (r R) WithFoldCase() R

WithFoldCase returns a copy of the result with the fold case bit set.

func (R) WithSkipDir

func (r R) WithSkipDir() R

WithSkipDir returns a copy of the result with the skip dir bit set.