blob: 1312875072f90cbe9ac6bb14346a5546866ed1a4 [file] [log] [blame]
Don Newton7577f072020-01-06 12:41:11 -05001// Copyright (c) 2016 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
21package zap
22
23import (
24 "flag"
25
26 "go.uber.org/zap/zapcore"
27)
28
29// LevelFlag uses the standard library's flag.Var to declare a global flag
30// with the specified name, default, and usage guidance. The returned value is
31// a pointer to the value of the flag.
32//
33// If you don't want to use the flag package's global state, you can use any
34// non-nil *Level as a flag.Value with your own *flag.FlagSet.
35func LevelFlag(name string, defaultLevel zapcore.Level, usage string) *zapcore.Level {
36 lvl := defaultLevel
37 flag.Var(&lvl, name, usage)
38 return &lvl
39}