Documentation
¶
Index ¶
- func ReadBatch[T any](ctx context.Context, iterator Iterator[T], batchSize int, ...) error
- func Slice[T any](it Iterator[T]) ([]T, error)
- type AsyncBatchIterator
- type BufferedIterator
- type Iterator
- func CloneN[T any](it Iterator[T], n int) ([]Iterator[T], error)
- func NewBufferedIterator[T any](it Iterator[T], size int) Iterator[T]
- func NewEmptyIterator[T any]() Iterator[T]
- func NewErrIterator[A any](err error) Iterator[A]
- func NewMergeIterator[P Profile](max P, deduplicate bool, iters ...Iterator[P]) Iterator[P]
- func NewSliceIndexIterator[T constraints.Integer, M any](s []M, i Iterator[T]) Iterator[M]
- func NewSliceIterator[A any](s []A) Iterator[A]
- func NewTimeRangedIterator[T Timestamp](it Iterator[T], min, max model.Time) Iterator[T]
- func NewUnionIterator[T any](iters ...Iterator[T]) Iterator[T]
- func Tee[T any](iter Iterator[T]) (a, b Iterator[T])
- func TeeN[T any](iter Iterator[T], n int) []Iterator[T]
- type MergeIterator
- type Profile
- type SeekIterator
- type TimeRangedIterator
- type Timestamp
- type TreeIterator
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ReadBatch ¶
func ReadBatch[T any](ctx context.Context, iterator Iterator[T], batchSize int, fn func(context.Context, []T) error) error
ReadBatch reads profiles from the iterator in batches and call fn. If fn returns an error, the iteration is stopped and the error is returned. The array passed in fn is reused between calls, so it should be copied if needed.
Types ¶
type AsyncBatchIterator ¶ added in v1.2.0
type AsyncBatchIterator[T, N any] struct { // contains filtered or unexported fields }
func NewAsyncBatchIterator ¶ added in v1.2.0
func NewAsyncBatchIterator[T, N any]( iterator Iterator[T], size int, clone func(T) N, release func([]N), ) *AsyncBatchIterator[T, N]
func (*AsyncBatchIterator[T, N]) At ¶ added in v1.2.0
func (x *AsyncBatchIterator[T, N]) At() N
func (*AsyncBatchIterator[T, N]) Close ¶ added in v1.2.0
func (x *AsyncBatchIterator[T, N]) Close() error
func (*AsyncBatchIterator[T, N]) Err ¶ added in v1.2.0
func (x *AsyncBatchIterator[T, N]) Err() error
func (*AsyncBatchIterator[T, N]) Next ¶ added in v1.2.0
func (x *AsyncBatchIterator[T, N]) Next() bool
type BufferedIterator ¶
func (*BufferedIterator[T]) At ¶
func (it *BufferedIterator[T]) At() T
func (*BufferedIterator[T]) Close ¶
func (it *BufferedIterator[T]) Close() error
func (*BufferedIterator[T]) Err ¶
func (it *BufferedIterator[T]) Err() error
func (*BufferedIterator[T]) Next ¶
func (it *BufferedIterator[T]) Next() bool
type Iterator ¶
type Iterator[A any] interface { // Next advances the iterator and returns true if another value was found. Next() bool // At returns the value at the current iterator position. At() A // Err returns the last error of the iterator. Err() error Close() error }
func CloneN ¶
CloneN returns N copy of the iterator. The returned iterators are independent of the original iterator. The original might be exhausted and should be discarded.
func NewBufferedIterator ¶
NewBufferedIterator returns an iterator that reads asynchronously from the given iterator and buffers up to size elements.
func NewEmptyIterator ¶
func NewErrIterator ¶
func NewMergeIterator ¶
NewMergeIterator returns an iterator that k-way merges the given iterators. The given iterators must be sorted by timestamp and labels themselves. Optionally, the iterator can deduplicate profiles with the same timestamp and labels.
func NewSliceIndexIterator ¶
func NewSliceIndexIterator[T constraints.Integer, M any](s []M, i Iterator[T]) Iterator[M]
func NewSliceIterator ¶
func NewTimeRangedIterator ¶
func NewUnionIterator ¶
func Tee ¶ added in v1.2.0
Tee returns 2 independent iterators from a single iterable.
The original iterator should not be used anywhere else, except that it's caller responsibility to close it and handle the error, after all the tee iterators finished.
Tee buffers source objects, and frees them eventually: when an object from the source iterator is consumed, the ownership is transferred to Tee. Therefore, the caller must ensure the source iterator never reuses objects returned with At.
Tee never blocks the leader iterator, instead, it grows the internal buffer: if any of the returned iterators are abandoned, all source iterator objects will be held in the buffer.
type MergeIterator ¶
type MergeIterator[P Profile] struct { // contains filtered or unexported fields }
func (*MergeIterator[P]) At ¶
func (i *MergeIterator[P]) At() P
func (*MergeIterator[P]) Close ¶
func (i *MergeIterator[P]) Close() error
func (*MergeIterator[P]) Err ¶
func (i *MergeIterator[P]) Err() error
func (*MergeIterator[P]) Next ¶
func (i *MergeIterator[P]) Next() bool
type Profile ¶
type Profile interface {
Labels() phlaremodel.Labels
Timestamp
}
type SeekIterator ¶
type SeekIterator[A any, B any] interface { Iterator[A] // Like Next but skips over results until reading >= the given location Seek(pos B) bool }
func NewErrSeekIterator ¶
func NewErrSeekIterator[A any, B any](err error) SeekIterator[A, B]
func NewSliceSeekIterator ¶
func NewSliceSeekIterator[A constraints.Ordered](s []A) SeekIterator[A, A]
type TimeRangedIterator ¶
type TimeRangedIterator[T Timestamp] struct { Iterator[T] // contains filtered or unexported fields }
func (*TimeRangedIterator[T]) Next ¶
func (it *TimeRangedIterator[T]) Next() bool
type TreeIterator ¶
func NewTreeIterator ¶
func NewTreeIterator[T any](tree *loser.Tree[T, Iterator[T]]) *TreeIterator[T]
NewTreeIterator returns an Iterator that iterates over the given loser tree iterator.
func (TreeIterator[T]) At ¶
func (it TreeIterator[T]) At() T
func (*TreeIterator[T]) Close ¶
func (it *TreeIterator[T]) Close() error
func (*TreeIterator[T]) Err ¶
func (it *TreeIterator[T]) Err() error
Source Files