Golang strconv.FormatBool Function

The strconv.FormatBool function in Golang is part of the strconv package and is used to convert a boolean value (true or false) into its string representation. This function is particularly useful when you need to convert boolean values to strings, such as for logging, outputting data, or generating JSON.

Table of Contents

1. Introduction
2. strconv.FormatBool Function Syntax
3. Examples
   • Basic Usage
   • Formatting Boolean Values in a Struct
   • Using strconv.FormatBool in JSON Construction
4. Real-World Use Case Example
5. Conclusion

Introduction

The strconv.FormatBool function is a simple utility that converts boolean values to their string equivalents, "true" or "false". It’s commonly used in scenarios where boolean values need to be output as part of a text string or where they need to be included in a larger data format, such as JSON or XML.

strconv.FormatBool Function Syntax

The syntax for the strconv.FormatBool function is as follows:

func FormatBool(b bool) string

Parameters:

• b bool: The boolean value to be converted.

Returns:

• string: The string representation of the boolean value, either "true" or "false".

Behavior:

• Converts the boolean to a string: The function returns the string "true" if the boolean value is true, and "false" if the boolean value is false.

Examples

Basic Usage

This example demonstrates how to use strconv.FormatBool to convert a boolean value to its string representation.

Example

package main

import (
	"fmt"
	"strconv"
)

func main() {
	b := true
	str := strconv.FormatBool(b)
	fmt.Println("Boolean as string:", str)
}

Output:

Boolean as string: true

Explanation:

• The strconv.FormatBool function converts the boolean value true to the string "true" and prints it.

Formatting Boolean Values in a Struct

This example shows how to use strconv.FormatBool to format boolean values within a struct, preparing the struct for string-based output.

Example

package main

import (
	"fmt"
	"strconv"
)

type User struct {
	Name   string
	Active bool
}

func (u User) String() string {
	return u.Name + " is active: " + strconv.FormatBool(u.Active)
}

func main() {
	user := User{Name: "Alice", Active: true}
	fmt.Println(user.String())
}

Output:

Alice is active: true

Explanation:

• The strconv.FormatBool function is used within the String method of the User struct to format the boolean Active field as a string.

Using strconv.FormatBool in JSON Construction

This example demonstrates how to manually construct a simple JSON object that includes a boolean value using strconv.FormatBool.

Example

package main

import (
	"fmt"
	"strconv"
)

func main() {
	active := true
	json := `{"active":` + strconv.FormatBool(active) + `}`
	fmt.Println("JSON:", json)
}

Output:

JSON: {"active":true}

Explanation:

• The strconv.FormatBool function is used to convert the boolean value true to its string representation "true", which is then included in the manually constructed JSON string.

Real-World Use Case Example: Generating a Log Message

A practical use case for strconv.FormatBool is generating log messages where boolean values need to be included in a human-readable format.

Example: Generating a Log Message

package main

import (
	"fmt"
	"strconv"
)

func main() {
	success := false
	logMessage := "Operation success: " + strconv.FormatBool(success)
	fmt.Println(logMessage)
}

Output:

Operation success: false

Explanation:

• The strconv.FormatBool function is used to convert the boolean value false to its string representation "false", which is then included in the log message.

Conclusion

The strconv.FormatBool function in Go is a straightforward and useful tool for converting boolean values to strings. It simplifies the process of generating human-readable output that includes boolean data, whether you’re constructing log messages, generating JSON, or preparing data for text-based formats. By using strconv.FormatBool, you can easily ensure that boolean values are accurately represented as strings in your Go applications.