github.com/zppinho/prow@v0.0.0-20240510014325-1738badeb017/pkg/flagutil/bool.go (about)

     1  /*
     2  Copyright 2019 The Kubernetes Authors.
     3  
     4  Licensed under the Apache License, Version 2.0 (the "License");
     5  you may not use this file except in compliance with the License.
     6  You may obtain a copy of the License at
     7  
     8      http://www.apache.org/licenses/LICENSE-2.0
     9  
    10  Unless required by applicable law or agreed to in writing, software
    11  distributed under the License is distributed on an "AS IS" BASIS,
    12  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    13  See the License for the specific language governing permissions and
    14  limitations under the License.
    15  */
    16  
    17  package flagutil
    18  
    19  import (
    20  	"strconv"
    21  )
    22  
    23  // Bool holds a boolean flag value, tracking whether it was set explicitly.
    24  type Bool struct {
    25  	Value    bool
    26  	Explicit bool
    27  }
    28  
    29  // IsBoolFlag causes golang to consider --foo to mean --foo=true
    30  func (b *Bool) IsBoolFlag() bool {
    31  	return true
    32  }
    33  
    34  // String value of the string.
    35  func (b *Bool) String() string {
    36  	return strconv.FormatBool(b.Value)
    37  }
    38  
    39  // Set the bool according to the string.
    40  func (b *Bool) Set(s string) error {
    41  	v, err := strconv.ParseBool(s)
    42  	if err != nil {
    43  		return err
    44  	}
    45  	b.Explicit = true
    46  	b.Value = v
    47  	return nil
    48  }