istio.io/istio@v0.0.0-20240520182934-d79c90f27776/pkg/config/analysis/context.go (about)

     1  // Copyright Istio Authors
     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  package analysis
    16  
    17  import (
    18  	"istio.io/istio/pkg/config"
    19  	"istio.io/istio/pkg/config/analysis/diag"
    20  	"istio.io/istio/pkg/config/resource"
    21  )
    22  
    23  // IteratorFn is used to iterate over a set of collection entries. It must return true to keep iterating.
    24  type IteratorFn func(r *resource.Instance) bool
    25  
    26  // Context is an analysis context that is passed to individual analyzers.
    27  type Context interface {
    28  	// Report a diagnostic message
    29  	Report(c config.GroupVersionKind, t diag.Message)
    30  
    31  	// Find a resource in the collection. If not found, nil is returned
    32  	Find(c config.GroupVersionKind, name resource.FullName) *resource.Instance
    33  
    34  	// Exists returns true if the specified resource exists in the context, false otherwise
    35  	Exists(c config.GroupVersionKind, name resource.FullName) bool
    36  
    37  	// ForEach iterates over all the entries of a given collection.
    38  	ForEach(c config.GroupVersionKind, fn IteratorFn)
    39  
    40  	// Canceled indicates that the context has been canceled. The analyzer should stop executing as soon as possible.
    41  	Canceled() bool
    42  
    43  	SetAnalyzer(analyzerName string)
    44  }