github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/dbnode/storage/index/query_matcher.go (about)

     1  // Copyright (c) 2018 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  	"fmt"
    25  
    26  	"github.com/m3db/m3/src/m3ninx/idx"
    27  
    28  	"github.com/golang/mock/gomock"
    29  )
    30  
    31  // QueryMatcher is a gomock.Matcher that matches index.Query
    32  type QueryMatcher interface {
    33  	gomock.Matcher
    34  }
    35  
    36  // NewQueryMatcher returns a new QueryMatcher
    37  func NewQueryMatcher(q Query) QueryMatcher {
    38  	return &queryMatcher{
    39  		query:   q,
    40  		matcher: idx.NewQueryMatcher(q.Query),
    41  	}
    42  }
    43  
    44  type queryMatcher struct {
    45  	query   Query
    46  	matcher idx.QueryMatcher
    47  }
    48  
    49  func (m *queryMatcher) Matches(x interface{}) bool {
    50  	query, ok := x.(Query)
    51  	if !ok {
    52  		return false
    53  	}
    54  
    55  	return m.matcher.Matches(query.Query)
    56  }
    57  
    58  func (m *queryMatcher) String() string {
    59  	return fmt.Sprintf("QueryMatcher %v", m.query)
    60  }