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

     1  // Copyright (c) 2020 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 limits
    22  
    23  import xerrors "github.com/m3db/m3/src/x/errors"
    24  
    25  type queryLimitExceededError struct {
    26  	msg string
    27  }
    28  
    29  // NewQueryLimitExceededError creates a query limit exceeded error.
    30  func NewQueryLimitExceededError(msg string) error {
    31  	return &queryLimitExceededError{
    32  		msg: msg,
    33  	}
    34  }
    35  
    36  func (err *queryLimitExceededError) Error() string {
    37  	return err.msg
    38  }
    39  
    40  // IsQueryLimitExceededError returns true if the error is a query limits exceeded error.
    41  func IsQueryLimitExceededError(err error) bool {
    42  	//nolint:errorlint
    43  	for err != nil {
    44  		if _, ok := err.(*queryLimitExceededError); ok {
    45  			return true
    46  		}
    47  		if multiErr, ok := err.(xerrors.MultiError); ok {
    48  			for _, e := range multiErr.Errors() {
    49  				if IsQueryLimitExceededError(e) {
    50  					return true
    51  				}
    52  			}
    53  		}
    54  		err = xerrors.InnerError(err)
    55  	}
    56  	return false
    57  }