fs

Documentation

Index

• func NewFieldRetriever(opts *Options) persist.FieldRetriever
• func NewPersistManager(opts *Options) persist.Manager
• type Options
  • func NewOptions() *Options
  • func (o *Options) ClockOptions() clock.Options
  • func (o *Options) FieldPathSeparator() byte
  • func (o *Options) FilePathPrefix() string
  • func (o *Options) InstrumentOptions() instrument.Options
  • func (o *Options) MmapEnableHugePages() bool
  • func (o *Options) MmapHugePagesThreshold() int64
  • func (o *Options) NewDirectoryMode() os.FileMode
  • func (o *Options) NewFileMode() os.FileMode
  • func (o *Options) ReadBufferSize() int
  • func (o *Options) SetClockOptions(v clock.Options) *Options
  • func (o *Options) SetFieldPathSeparator(v byte) *Options
  • func (o *Options) SetFilePathPrefix(v string) *Options
  • func (o *Options) SetInstrumentOptions(v instrument.Options) *Options
  • func (o *Options) SetMmapEnableHugePages(v bool) *Options
  • func (o *Options) SetMmapHugePagesThreshold(v int64) *Options
  • func (o *Options) SetNewDirectoryMode(v os.FileMode) *Options
  • func (o *Options) SetNewFileMode(v os.FileMode) *Options
  • func (o *Options) SetReadBufferSize(v int) *Options
  • func (o *Options) SetTimestampPrecision(v time.Duration) *Options
  • func (o *Options) SetWriteBufferSize(v int) *Options
  • func (o *Options) TimestampPrecision() time.Duration
  • func (o *Options) WriteBufferSize() int

Functions

func NewFieldRetriever

func NewFieldRetriever(opts *Options) persist.FieldRetriever

NewFieldRetriever creates a new field retriever.

func NewPersistManager

func NewPersistManager(opts *Options) persist.Manager

NewPersistManager creates a new filesystem persist manager. TODO(xichen): Persistence rate limiting.

Types

type Options

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

Options provide a set of options for data persistence.

func NewOptions

func NewOptions() *Options

NewOptions provide a new set of options.

func (*Options) ClockOptions

func (o *Options) ClockOptions() clock.Options

ClockOptions returns the clock options.

func (*Options) FieldPathSeparator

func (o *Options) FieldPathSeparator() byte

FieldPathSeparator returns the field separator.

func (*Options) FilePathPrefix

func (o *Options) FilePathPrefix() string

FilePathPrefix returns the file path prefix for persisted dataset.

func (*Options) InstrumentOptions

func (o *Options) InstrumentOptions() instrument.Options

InstrumentOptions returns the instrument options.

func (*Options) MmapEnableHugePages

func (o *Options) MmapEnableHugePages() bool

MmapEnableHugePages returns whether to enable huge pages or not.

func (*Options) MmapHugePagesThreshold

func (o *Options) MmapHugePagesThreshold() int64

MmapHugePagesThreshold returns the threshold for when to enable huge pages if enabled.

func (*Options) NewDirectoryMode

func (o *Options) NewDirectoryMode() os.FileMode

NewDirectoryMode returns the new directory mode.

func (*Options) NewFileMode

func (o *Options) NewFileMode() os.FileMode

NewFileMode returns the new file mode.

func (*Options) ReadBufferSize

func (o *Options) ReadBufferSize() int

ReadBufferSize returns the buffer size for reading data from files.

func (*Options) SetClockOptions

func (o *Options) SetClockOptions(v clock.Options) *Options

SetClockOptions sets the clock options.

func (*Options) SetFieldPathSeparator

func (o *Options) SetFieldPathSeparator(v byte) *Options

SetFieldPathSeparator sets the field separator.

func (*Options) SetFilePathPrefix

func (o *Options) SetFilePathPrefix(v string) *Options

SetFilePathPrefix sets the file path prefix for persisted dataset.

func (*Options) SetInstrumentOptions

func (o *Options) SetInstrumentOptions(v instrument.Options) *Options

SetInstrumentOptions sets the instrument options.

func (*Options) SetMmapEnableHugePages

func (o *Options) SetMmapEnableHugePages(v bool) *Options

SetMmapEnableHugePages sets whether to enable huge pages or not.

func (*Options) SetMmapHugePagesThreshold

func (o *Options) SetMmapHugePagesThreshold(v int64) *Options

SetMmapHugePagesThreshold sets the threshold for when to enable huge pages if enabled.

func (*Options) SetNewDirectoryMode

func (o *Options) SetNewDirectoryMode(v os.FileMode) *Options

SetNewDirectoryMode sets the new directory mode.

func (*Options) SetNewFileMode

func (o *Options) SetNewFileMode(v os.FileMode) *Options

SetNewFileMode sets the new file mode.

func (*Options) SetReadBufferSize

func (o *Options) SetReadBufferSize(v int) *Options

SetReadBufferSize sets the buffer size for reading data from files.

func (*Options) SetTimestampPrecision

func (o *Options) SetTimestampPrecision(v time.Duration) *Options

SetTimestampPrecision sets the timestamp precision.

func (*Options) SetWriteBufferSize

func (o *Options) SetWriteBufferSize(v int) *Options

SetWriteBufferSize sets the buffer size for writing data to files.

func (*Options) TimestampPrecision

func (o *Options) TimestampPrecision() time.Duration

TimestampPrecision returns the timestamp precision.

func (*Options) WriteBufferSize

func (o *Options) WriteBufferSize() int

WriteBufferSize returns the buffer size for writing data to files.