input

Documentation

Index

• func IsRegularFile(file *os.File) bool
• 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) IsRegularFile() bool
  • func (f1 *File) IsSameFile(f2 *File) bool
• type FileEvent
  • func (f *FileEvent) GetState() *FileState
  • func (f *FileEvent) SetFieldsUnderRoot(fieldsUnderRoot bool)
  • func (f *FileEvent) ToMapStr() common.MapStr
• type FileState
• type FileStateOS
  • func GetOSFileState(info *os.FileInfo) *FileStateOS
  • func (fs *FileStateOS) IsSame(state *FileStateOS) bool

Functions

func IsRegularFile

func IsRegularFile(file *os.File) bool

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 As Windows blocks deleting a file when its open, some special params are passed here.

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
	FileState *FileState
}

func (*File) IsRegularFile

func (f *File) IsRegularFile() bool

Check that the file isn't a symlink, mode is regular or file is nil

func (*File) IsSameFile

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

Checks if the two files are the same.

type FileEvent

type FileEvent struct {
	ReadTime     time.Time
	Source       *string
	InputType    string
	DocumentType string
	Offset       int64
	Bytes        int
	Text         *string
	Fields       *common.MapStr
	Fileinfo     *os.FileInfo
	// contains filtered or unexported fields
}

FileEvent is sent to the output and must contain all relevant information

func (*FileEvent) GetState

func (f *FileEvent) GetState() *FileState

GetState builds and returns the FileState object based on the Event info.

func (*FileEvent) SetFieldsUnderRoot

func (f *FileEvent) SetFieldsUnderRoot(fieldsUnderRoot bool)

SetFieldsUnderRoot sets whether the fields should be added top level to the output documentation (fieldsUnderRoot = true) or under a fields dictionary.

func (*FileEvent) ToMapStr

func (f *FileEvent) ToMapStr() common.MapStr

type FileState

type FileState struct {
	Source      *string `json:"source,omitempty"`
	Offset      int64   `json:"offset,omitempty"`
	FileStateOS *FileStateOS
}

type FileStateOS

type FileStateOS struct {
	IdxHi uint64 `json:"idxhi,omitempty"`
	IdxLo uint64 `json:"idxlo,omitempty"`
	Vol   uint64 `json:"vol,omitempty"`
}

func GetOSFileState

func GetOSFileState(info *os.FileInfo) *FileStateOS

GetOSFileState returns the platform specific FileStateOS

func (*FileStateOS) IsSame

func (fs *FileStateOS) IsSame(state *FileStateOS) bool

IsSame file checks if the files are identical