github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/metrics/errors/errors.go (about)

     1  // Copyright (c) 2017 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 errors
    22  
    23  // InvalidInputError is returned when a rule or rule change is applied which
    24  // is invalid.
    25  type InvalidInputError string
    26  
    27  // NewInvalidInputError creates a new invalid input error.
    28  func NewInvalidInputError(str string) error { return InvalidInputError(str) }
    29  func (e InvalidInputError) Error() string   { return string(e) }
    30  
    31  // ValidationError is returned when validation failed.
    32  type ValidationError string
    33  
    34  // NewValidationError creates a new validation error.
    35  func NewValidationError(str string) error { return ValidationError(str) }
    36  func (e ValidationError) Error() string   { return string(e) }
    37  
    38  // StaleDataError is returned when a rule modification can not be completed
    39  // because rule metadata is no longer valid.
    40  type StaleDataError string
    41  
    42  // NewStaleDataError creates a new version mismatch error.
    43  func NewStaleDataError(str string) error { return StaleDataError(str) }
    44  func (e StaleDataError) Error() string   { return string(e) }
    45  
    46  // NotFoundError is returned when fetching value from rule store that does not exist.
    47  type NotFoundError string
    48  
    49  // NewNotFoundError creates a new not found error.
    50  func NewNotFoundError(str string) error { return NotFoundError(str) }
    51  func (e NotFoundError) Error() string   { return string(e) }