file

package

v6.0.0-alpha2+incompat... Latest Latest Go to latest Published: May 31, 2017 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/narph/beats

Links

Open Source Insights

Documentation ¶

Rendered for

Index ¶

func Glob(pattern string, doubleStarPatternDepth uint8) ([]string, error)
func GlobPatterns(pattern string, doubleStarPatternDepth uint8) ([]string, error)
func IsSameFile(path string, info os.FileInfo) bool
func ReadOpen(path string) (*os.File, error)
func SafeFileRotate(path, tempfile string) error
type File
- func (f *File) IsSameFile(f2 *File) bool
type State
- func NewState(fileInfo os.FileInfo, path string, t string) State
type StateOS
- func GetOSState(info os.FileInfo) StateOS
- func (fs StateOS) IsSame(state StateOS) bool
- func (fs StateOS) String() string
type States
- func NewStates() *States

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Glob ¶

func Glob(pattern string, doubleStarPatternDepth uint8) ([]string, error)

Glob expands '**' patterns into multiple patterns to satisfy https://golang.org/pkg/path/filepath/#Match

func GlobPatterns ¶

func GlobPatterns(pattern string, doubleStarPatternDepth uint8) ([]string, error)

GlobPatterns detects the use of "**" and expands it to standard glob patterns up to a max depth

func IsSameFile ¶

func IsSameFile(path string, info os.FileInfo) bool

IsSameFile checks if the given File path corresponds with the FileInfo given

func ReadOpen ¶

func ReadOpen(path string) (*os.File, error)

ReadOpen opens a file for reading only

func SafeFileRotate ¶

func SafeFileRotate(path, tempfile string) error

SafeFileRotate safely rotates an existing file under path and replaces it with the tempfile

Types ¶

type File ¶

type File struct {
	File     *os.File
	FileInfo os.FileInfo
	Path     string
	State    *State
}

func (*File) IsSameFile ¶

func (f *File) IsSameFile(f2 *File) bool

Checks if the two files are the same.

type State ¶

type State struct {
	Id          string        `json:"-"` // local unique id to make comparison more efficient
	Finished    bool          `json:"-"` // harvester state
	Fileinfo    os.FileInfo   `json:"-"` // the file info
	Source      string        `json:"source"`
	Offset      int64         `json:"offset"`
	Timestamp   time.Time     `json:"timestamp"`
	TTL         time.Duration `json:"ttl"`
	Type        string        `json:"type"`
	FileStateOS StateOS
}

State is used to communicate the reading state of a file

func NewState ¶

func NewState(fileInfo os.FileInfo, path string, t string) State

NewState creates a new file state

func (*State) ID ¶

func (s *State) ID() string

ID returns a unique id for the state as a string

func (*State) IsEmpty ¶

func (s *State) IsEmpty() bool

IsEmpty returns true if the state is empty

func (*State) IsEqual ¶

func (s *State) IsEqual(c *State) bool

IsEqual compares the state to an other state supporing stringer based on the unique string

type StateOS ¶

type StateOS struct {
	Inode  uint64 `json:"inode,"`
	Device uint64 `json:"device,"`
}

func GetOSState ¶

func GetOSState(info os.FileInfo) StateOS

GetOSState returns the FileStateOS for non windows systems

func (StateOS) IsSame ¶

func (fs StateOS) IsSame(state StateOS) bool

IsSame file checks if the files are identical

func (StateOS) String ¶

func (fs StateOS) String() string

type States ¶

type States struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

States handles list of FileState

func NewStates ¶

func NewStates() *States

func (*States) Cleanup ¶

func (s *States) Cleanup() int

Cleanup cleans up the state array. All states which are older then `older` are removed The number of states that were cleaned up is returned

func (*States) Copy ¶

func (s *States) Copy() *States

Copy create a new copy of the states object

func (*States) Count ¶

func (s *States) Count() int

Count returns number of states

func (*States) FindPrevious ¶

func (s *States) FindPrevious(newState State) State

func (*States) GetStates ¶

func (s *States) GetStates() []State

Returns a copy of the file states

func (*States) SetStates ¶

func (s *States) SetStates(states []State)

SetStates overwrites all internal states with the given states array

func (*States) Update ¶

func (s *States) Update(newState State)

Update updates a state. If previous state didn't exist, new one is created

Source Files ¶

View all Source files

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