github.com/google/fleetspeak@v0.1.15-0.20240426164851-4f31f62c1aea/fleetspeak/src/common/should/never_oss.go (about)

     1  // Copyright 2024 Google LLC
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  //go:build !google_internal
    16  
    17  // Package should lets callers indicate impossible conditions from the code.
    18  //
    19  // It is a lightweight way to make these impossible conditions observable,
    20  // when it is hooked up with an appropriate monitoring framework.
    21  package should
    22  
    23  // Never indicates that the given condition should never (or seldomly) happen.
    24  //
    25  // Callers should only pass a fixed set of strings to Never(),
    26  // to avoid a state explosion in monitoring counters.
    27  func Never(condition string) {
    28  	// Unfortunately empty in the open source version.
    29  }