package
0.0.0-20191121140916-9649366ff4b2
Repository: https://github.com/chronosphereiox/m3.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author
No description provided by the author

# Functions

LeadingAndTrailingZeros calculates the number of leading and trailing 0s for a uint64.
NewEncoderPool creates a new pool.
NewIStream creates a new Istream.
NewMockDecoder creates a new mock instance.
NewMockEncoder creates a new mock instance.
NewMockEncoderPool creates a new mock instance.
NewMockIStream creates a new mock instance.
NewMockIterator creates a new mock instance.
NewMockIteratorPools creates a new mock instance.
NewMockMultiReaderIterator creates a new mock instance.
NewMockMultiReaderIteratorArrayPool creates a new mock instance.
NewMockMultiReaderIteratorPool creates a new mock instance.
NewMockMutableSeriesIterators creates a new mock instance.
NewMockMutableSeriesIteratorsPool creates a new mock instance.
NewMockOptions creates a new mock instance.
NewMockOStream creates a new mock instance.
NewMockReaderIterator creates a new mock instance.
NewMockReaderIteratorPool creates a new mock instance.
NewMockSeriesIterator creates a new mock instance.
NewMockSeriesIteratorPool creates a new mock instance.
NewMockSeriesIterators creates a new mock instance.
NewMultiReaderIterator creates a new multi-reader iterator.
NewMultiReaderIteratorArrayPool creates a new pool.
NewMultiReaderIteratorPool creates a new pool for MultiReaderIterators.
NewMutableSeriesIteratorsPool creates a new pool.
NewNullEncoder returns a new encoder that performs no operations.
NewNullReaderIterator returns a new reader iterator that performs no operations.
NewOptions creates a new options.
NewOStream creates a new Ostream.
NewReaderIteratorPool creates a new pool for ReaderIterators.
NewSeriesIterator creates a new series iterator.
NewSeriesIteratorPool creates a new pool for SeriesIterators.
NewSeriesIterators creates a new series iterators collection.
NumSig returns the number of significant values in a uint64.
ParseIterateEqualTimestampStrategy parses a IterateEqualTimestampStrategy from a string.
SignExtend sign extends the highest bit of v which has numBits (<=64).
ValidIterateEqualTimestampStrategies returns the valid iterate equal timestamp strategies.
WriteSpecialMarker writes the marker that marks the start of a special symbol, e.g., the eos marker, the annotation marker, or the time unit marker.

# Constants

DefaultIterateEqualTimestampStrategy is the default iterate equal timestamp strategy.
IterateHighestFrequencyValue is useful across replicas when you want to choose the most common appearing value, however you can only use this reliably if you wait for values from all replicas to be retrieved, i.e.
IterateHighestValue is useful across replicas when you just want to choose the highest value every time.
IterateLastPushed is useful for within a single replica, using the last immutable buffer that was created to decide which value to choose.
IterateLowestValue is useful across replicas when you just want to choose the lowest value every time.

# Variables

EmptySeriesIterators is an empty SeriesIterators.

# Structs

MockDecoder is a mock of Decoder interface.
MockDecoderMockRecorder is the mock recorder for MockDecoder.
MockEncoder is a mock of Encoder interface.
MockEncoderMockRecorder is the mock recorder for MockEncoder.
MockEncoderPool is a mock of EncoderPool interface.
MockEncoderPoolMockRecorder is the mock recorder for MockEncoderPool.
MockIStream is a mock of IStream interface.
MockIStreamMockRecorder is the mock recorder for MockIStream.
MockIterator is a mock of Iterator interface.
MockIteratorMockRecorder is the mock recorder for MockIterator.
MockIteratorPools is a mock of IteratorPools interface.
MockIteratorPoolsMockRecorder is the mock recorder for MockIteratorPools.
MockMultiReaderIterator is a mock of MultiReaderIterator interface.
MockMultiReaderIteratorArrayPool is a mock of MultiReaderIteratorArrayPool interface.
MockMultiReaderIteratorArrayPoolMockRecorder is the mock recorder for MockMultiReaderIteratorArrayPool.
MockMultiReaderIteratorMockRecorder is the mock recorder for MockMultiReaderIterator.
MockMultiReaderIteratorPool is a mock of MultiReaderIteratorPool interface.
MockMultiReaderIteratorPoolMockRecorder is the mock recorder for MockMultiReaderIteratorPool.
MockMutableSeriesIterators is a mock of MutableSeriesIterators interface.
MockMutableSeriesIteratorsMockRecorder is the mock recorder for MockMutableSeriesIterators.
MockMutableSeriesIteratorsPool is a mock of MutableSeriesIteratorsPool interface.
MockMutableSeriesIteratorsPoolMockRecorder is the mock recorder for MockMutableSeriesIteratorsPool.
MockOptions is a mock of Options interface.
MockOptionsMockRecorder is the mock recorder for MockOptions.
MockOStream is a mock of OStream interface.
MockOStreamMockRecorder is the mock recorder for MockOStream.
MockReaderIterator is a mock of ReaderIterator interface.
MockReaderIteratorMockRecorder is the mock recorder for MockReaderIterator.
MockReaderIteratorPool is a mock of ReaderIteratorPool interface.
MockReaderIteratorPoolMockRecorder is the mock recorder for MockReaderIteratorPool.
MockSeriesIterator is a mock of SeriesIterator interface.
MockSeriesIteratorMockRecorder is the mock recorder for MockSeriesIterator.
MockSeriesIteratorPool is a mock of SeriesIteratorPool interface.
MockSeriesIteratorPoolMockRecorder is the mock recorder for MockSeriesIteratorPool.
MockSeriesIterators is a mock of SeriesIterators interface.
MockSeriesIteratorsMockRecorder is the mock recorder for MockSeriesIterators.
SeriesIteratorOptions is a set of options for using a series iterator.

# Interfaces

Decoder is the generic interface for different types of decoders.
Encoder is the generic interface for different types of encoders.
EncoderPool provides a pool for encoders.
IStream encapsulates a readable stream.
Iterator is the generic interface for iterating over encoded data.
IteratorPools exposes a small subset of iterator pools that are sufficient for clients to rebuild SeriesIterator.
MarkerEncodingScheme captures the information related to marker encoding.
MultiReaderIterator is an iterator that iterates in order over a list of sets of internally ordered but not collectively in order readers, it also deduplicates datapoints.
MultiReaderIteratorArrayPool provides a pool for MultiReaderIterator arrays.
MultiReaderIteratorPool provides a pool for MultiReaderIterators.
MutableSeriesIterators is a mutable SeriesIterators.
MutableSeriesIteratorsPool provides a pool for MutableSeriesIterators.
Options represents different options for encoding time as well as markers.
OStream encapsulates a writable stream.
ReaderIterator is the interface for a single-reader iterator.
ReaderIteratorPool provides a pool for ReaderIterators.
SeriesIterator is an iterator that iterates over a set of iterators from different replicas and de-dupes & merges results from the replicas for a given series while also applying a time filter on top of the values in case replicas returned values out of range on either end.
SeriesIteratorPool provides a pool for SeriesIterator.
SeriesIterators is a collection of SeriesIterator that can close all iterators.
TimeBucket represents a bucket for encoding time values.
TimeEncodingScheme captures information related to time encoding.

# Type aliases

Bit is just a byte.
EncoderAllocate allocates an encoder for a pool.
IterateEqualTimestampStrategy describes the strategy of which value to select when values with equal timestamps appear in the list of iterators.
Marker represents the markers.
NewDecoderFn creates a new decoder.
NewEncoderFn creates a new encoder.
ReaderIteratorAllocate allocates a ReaderIterator for a pool.
TimeEncodingSchemes defines the time encoding schemes for different time units.