# README
go-base
Common Go utilities that are used across omegaUp's projects.
# Functions
ErrorWithCategory is similar to errors.Wrap, but instead of creating a new error as the wrapping message, a sentinel error is provided as a category.
FloatToRational returns a rational that's within 1e-6 of the floating-point value.
HasErrorCategory returns whether the provided error belongs to the provided category.
Max returns the larger of x or y.
Min returns the smaller of x or y.
NewKeyedPool creates a new object pool with the provided options.
NewLRUCache returns an empty LRUCache with the provided size limit.
NewRotatingFile opens path for writing in append-only mode and listens for SIGHUP so that it can reopen the file automatically.
NopOpenedCallback is an OpenedCallback that does nothing.
ParseRational returns a rational that's within 1e-6 of the floating-point value that has been serialized as a string.
RationalDiv implements division between two rationals.
RationalToFloat returns the closest float value to the given big.Rat.
UnwrapCauseFromErrorCategory finds an error with the specified category in the chain and returns its Cause().
# Variables
ErrKeyNotFound will be returned from Get to indicate that the key was not found to prevent returning a zero value.
# Structs
KeyedPool is an implementation of a length-bounded set of objects, each of which is associated with a key.
KeyedPoolOptions are options that can be passed to NewKeyedPool to customize the pool limits and functionality.
LRUCache handles a pool of sized resources.
NoOpMetrics is an implementation of Metrics that does nothing.
A RotatingFile is an io.WriteCloser that supports reopening through SIGHUP.
A SizedEntryRef is a wrapper around a SizedEntry.
# Interfaces
Metrics is an interface that supports updating different kinds of metrics.
A SizedEntry is an entry within the LRUCache that knows its own size.
# Type aliases
A Byte is a unit of digital information.
Duration is identical to time.Duration, except it can implements the json.Marshaler interface with time.Duration.String() and time.Duration.ParseDuration().
OpenedCallback allows the caller to specify an action to be performed when the file is opened and before it is available for writing.
Rat is identical to big.Rat, except it can implements the json.Marshaler interface so that it can also accept integers.
A SizedEntryFactory is a factory that can create a SizedEntry given its key name.