reader

Documentation

Index

• Constants
• type Factory
  • func (f *Factory) NewFingerprint(file *os.File) (*fingerprint.Fingerprint, error)
  • func (f *Factory) NewReader(file *os.File, fp *fingerprint.Fingerprint) (*Reader, error)
  • func (f *Factory) NewReaderFromMetadata(file *os.File, m *Metadata) (r *Reader, err error)
• type Metadata
  • func (m Metadata) GetFingerprint() *fingerprint.Fingerprint
• type Reader
  • func (r *Reader) Close() *Metadata
  • func (r *Reader) GetFileName() string
  • func (r *Reader) NameEquals(other *Reader) bool
  • func (r *Reader) Read(dst []byte) (n int, err error)
  • func (r *Reader) ReadToEnd(ctx context.Context)
  • func (r *Reader) Validate() bool

Constants

const (
	DefaultMaxLogSize   = 1024 * 1024
	DefaultFlushPeriod  = 500 * time.Millisecond
	DefaultMaxBatchSize = 100
)

Types

type Factory

type Factory struct {
	component.TelemetrySettings
	HeaderConfig            *header.Config
	FromBeginning           bool
	FingerprintSize         int
	BufPool                 sync.Pool
	InitialBufferSize       int
	MaxLogSize              int
	Encoding                encoding.Encoding
	SplitFunc               bufio.SplitFunc
	TrimFunc                trim.Func
	FlushTimeout            time.Duration
	EmitFunc                emit.Callback
	Attributes              attrs.Resolver
	DeleteAtEOF             bool
	IncludeFileRecordNumber bool
	Compression             string
	AcquireFSLock           bool
}

func (*Factory) NewFingerprint

func (f *Factory) NewFingerprint(file *os.File) (*fingerprint.Fingerprint, error)

func (*Factory) NewReader

func (f *Factory) NewReader(file *os.File, fp *fingerprint.Fingerprint) (*Reader, error)

func (*Factory) NewReaderFromMetadata

func (f *Factory) NewReaderFromMetadata(file *os.File, m *Metadata) (r *Reader, err error)

type Metadata

type Metadata struct {
	Fingerprint     *fingerprint.Fingerprint
	Offset          int64
	RecordNum       int64
	FileAttributes  map[string]any
	HeaderFinalized bool
	FlushState      flush.State
	TokenLenState   tokenlen.State
}

func (Metadata) GetFingerprint

func (m Metadata) GetFingerprint() *fingerprint.Fingerprint

type Reader

type Reader struct {
	*Metadata
	// contains filtered or unexported fields
}

Reader manages a single file

func (*Reader) Close

func (r *Reader) Close() *Metadata

Close will close the file and return the metadata

func (*Reader) GetFileName

func (r *Reader) GetFileName() string

func (*Reader) NameEquals

func (r *Reader) NameEquals(other *Reader) bool

func (*Reader) Read

func (r *Reader) Read(dst []byte) (n int, err error)

Read from the file and update the fingerprint if necessary

func (*Reader) ReadToEnd

func (r *Reader) ReadToEnd(ctx context.Context)

ReadToEnd will read until the end of the file

func (*Reader) Validate

func (r *Reader) Validate() bool

Validate returns true if the reader still has a valid file handle, false otherwise.