package
4.1.3+incompatible
Repository: https://github.com/els0r/goprobe.git
Documentation: pkg.go.dev

# Functions

DirTimestamp returns timestamp rounded down to the nearest directory time frame (usually a day).
SplitTimestampMetadataSuffix is a convenience function that performs timestamp (and potentially metadata prefix) extraction for the GPDir path / directory name.
FindDirForTimestamp finds the full path to a GPDir given a timestamp (if the metadata suffix is not known).
New returns a new GPFile object to read and write goProbe flow data.
NewDir instantiates a new directory (doesn't yet do anything except for potentially reading / decoding a subset of the metadata from a provided string suffix).
NewDirWriter instantiates a new directory for writing.
WithEncoder allows to set the compression implementation.
WithEncoderTypeLevel allows to set the compression type and level.
WithPermissions sets a non-default set of permissions / file mode for the file.
WithReadAll triggers a full read of the underlying file from disk upon first read access to minimize I/O load.

# Constants

EpochDay is one day in seconds.
FileSuffix denotes the suffix used for the raw data stored.
ModeRead denotes read access.
ModeWrite denotes write access (no O_APPEND to allow for Seek()).

# Variables

ErrDirNotOpen denotes that a GPDir is not (yet) open or has been closed.
ErrExceedsEncodingSize covers edge case scenarios where a block might (theoretically) contain data that exceeds the encoding width of 32-bit.
ErrInputSizeTooSmall is thrown if the input size for desiralization is too small to be valid.
ErrInvalidDirName denotes that the provided name for the GPDir is invalid.

# Structs

GPDir denotes a timestamped goDB directory (usually a daily set of blocks).
GPFile implements the binary data file used to store goProbe's flows.
Metadata denotes a serializable set of metadata (both globally and per-block).
Stats denotes statistics for a GPDir instance.
TrafficMetadata denotes a serializable set of metadata information about traffic stats.

# Type aliases

Option defines optional arguments to gpfile.