go.uber.org/yarpc@v1.72.1/x/debug/options.go (about)

     1  // Copyright (c) 2022 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 debug
    22  
    23  import "go.uber.org/zap"
    24  
    25  // Option is an interface for customizing debug handlers.
    26  type Option interface {
    27  	apply(*options)
    28  }
    29  
    30  type optionFunc func(*options)
    31  
    32  // opts represents the combined options supplied by the user.
    33  type options struct {
    34  	logger *zap.Logger
    35  	tmpl   templateIface
    36  }
    37  
    38  // Logger specifies the logger that should be used to log.
    39  // Default value is noop zap logger.
    40  func Logger(logger *zap.Logger) Option {
    41  	return optionFunc(func(opts *options) {
    42  		opts.logger = logger
    43  	})
    44  }
    45  
    46  // tmpl specifies the template to use.
    47  // It is only used for testing.
    48  func tmpl(tmpl templateIface) Option {
    49  	return optionFunc(func(opts *options) {
    50  		opts.tmpl = tmpl
    51  	})
    52  }
    53  func (f optionFunc) apply(options *options) { f(options) }
    54  
    55  // applyOptions creates new opts based on the given options.
    56  func applyOptions(opts ...Option) options {
    57  	options := options{
    58  		logger: zap.NewNop(),
    59  		tmpl:   _defaultTmpl,
    60  	}
    61  	for _, opt := range opts {
    62  		opt.apply(&options)
    63  	}
    64  	return options
    65  }