github.com/gravitational/teleport/api@v0.0.0-20240507183017-3110591cbafc/utils/bool.go (about)

     1  /*
     2  Copyright 2021 Gravitational, Inc.
     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 utils defines several functions used across the Teleport API and other packages
    18  package utils
    19  
    20  import (
    21  	"strings"
    22  
    23  	"github.com/gravitational/trace"
    24  )
    25  
    26  // ParseBool parses string as boolean value,
    27  // returns error in case if value is not recognized
    28  func ParseBool(value string) (bool, error) {
    29  	switch strings.ToLower(value) {
    30  	case "yes", "yeah", "y", "true", "1", "on":
    31  		return true, nil
    32  	case "no", "nope", "n", "false", "0", "off":
    33  		return false, nil
    34  	default:
    35  		return false, trace.BadParameter("unsupported value: %q", value)
    36  	}
    37  }