github.com/m3db/m3@v1.5.0/src/dbnode/storage/index/query_iter.go (about)

     1  // Copyright (c) 2021 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package index
    22  
    23  import (
    24  	"github.com/m3db/m3/src/m3ninx/doc"
    25  	"github.com/m3db/m3/src/x/context"
    26  )
    27  
    28  type queryIter struct {
    29  	// immutable state
    30  	docIter doc.QueryDocIterator
    31  
    32  	// mutable state
    33  	seriesCount, docCount int
    34  }
    35  
    36  var _ QueryIterator = &queryIter{}
    37  
    38  // NewQueryIter wraps the provided QueryDocIterator as a QueryIterator
    39  func NewQueryIter(docIter doc.QueryDocIterator) QueryIterator {
    40  	return &queryIter{
    41  		docIter: docIter,
    42  	}
    43  }
    44  
    45  func (q *queryIter) Done() bool {
    46  	return q.docIter.Done()
    47  }
    48  
    49  func (q *queryIter) Next(_ context.Context) bool {
    50  	return q.docIter.Next()
    51  }
    52  
    53  func (q *queryIter) Err() error {
    54  	return q.docIter.Err()
    55  }
    56  
    57  func (q *queryIter) Close() error {
    58  	return q.docIter.Close()
    59  }
    60  
    61  func (q *queryIter) AddSeries(count int) {
    62  	q.seriesCount += count
    63  }
    64  
    65  func (q *queryIter) AddDocs(count int) {
    66  	q.docCount += count
    67  }
    68  
    69  func (q *queryIter) Counts() (series, docs int) {
    70  	return q.seriesCount, q.docCount
    71  }
    72  
    73  func (q *queryIter) Current() doc.Document {
    74  	return q.docIter.Current()
    75  }