README
¶
golang-tern-expression
simple tern expression condition ? expression 1 : expression 2 in golang
tern
tern is a lightweight and versatile Go package designed to streamline conditional logic with concise ternary expressions, helping you write clean, expressive, and maintainable code with ease.
README
Features
- Generic Support: Fully leverages Go’s generics for type safety and flexibility across various data types.
- Flexible Logic: Provides robust support for both boolean conditions and conditional functions.
- Lazy Evaluation: Optimizes performance by computing values only when necessary through deferred execution.
- Zero Value Handling: Offers utilities to return default zero values for any type when no fallback is supplied.
Installation
go get github.com/yyle88/tern
Usage
The tern package provides multiple helper functions tailored to handle various conditional scenarios.
Basic Usage
package main
import (
"fmt"
"github.com/yyle88/tern"
)
func main() {
// Basic conditional selection
result := tern.BVV(true, "Option A", "Option B")
fmt.Println(result) // Output: Option A
// Deferred execution for fallback value
result = tern.BVF(false, "Default", func() string { return "Computed Fallback" })
fmt.Println(result) // Output: Computed Fallback
// Handling zero values as fallback
result = tern.BV(false, "Fallback")
fmt.Println(result) // Output: (empty string)
}
Function Overview
Here is an overview of the functions provided by the tern package:
| Function | Condition Type | Primary Value | Fallback Value |
|---|---|---|---|
BVV |
bool |
Direct value | Direct value |
BVF |
bool |
Direct value | Function returning value |
BFV |
bool |
Function returning value | Direct value |
BFF |
bool |
Function returning value | Function returning value |
FVV |
func() bool |
Direct value | Direct value |
FVF |
func() bool |
Direct value | Function returning value |
FFV |
func() bool |
Function returning value | Direct value |
FFF |
func() bool |
Function returning value | Function returning value |
Lazy Evaluation Example
Deferred execution ensures unnecessary computations are avoided, making your code more efficient:
func expensiveComputation() string {
fmt.Println("Computing...")
return "Heavy Result"
}
result := tern.BVF(false, "Default", expensiveComputation)
// Output: Default (expensiveComputation is not executed)
Working with Zero Values
The package provides Zero[T](), a utility that returns the zero value for any generic type:
package main
import (
"fmt"
"github.com/yyle88/tern"
)
func main() {
fmt.Println(tern.Zero[int]()) // Output: 0
fmt.Println(tern.Zero[string]()) // Output: (empty string)
}
Handling Zero-Value Fallbacks
The package includes functions that automatically handle zero values when the condition is not met:
| Function | Condition Type | Primary Value | Fallback Value |
|---|---|---|---|
BV |
bool |
Direct value | Zero value of type T |
BF |
bool |
Function returning value | Zero value of type T |
FV |
func() bool |
Direct value | Zero value of type T |
FF |
func() bool |
Function returning value | Zero value of type T |
Additional Utilities in the zerotern Package
The zerotern subpackage extends tern with specialized utilities for comparing values to their zero value, adding more control for fallback scenarios.
| Function | Comparison Type | Primary Value | Fallback Value |
|---|---|---|---|
VV |
Direct comparison | Direct value | Direct value |
VF |
Direct comparison | Direct value | Function returning value |
Example: Using VV and VF
package main
import (
"fmt"
"github.com/yyle88/tern/zerotern"
)
func main() {
// Direct comparison
result := zerotern.VV("non-zero", "fallback")
fmt.Println(result) // Output: non-zero
// Fallback with function
result = zerotern.VF("", func() string { return "fallback func" })
fmt.Println(result) // Output: fallback func
}
Pointer-Based Utility Functions in zerotern
| Function | Pointer Handling | Fallback Value |
|---|---|---|
SetPV |
Pointer to direct value | Direct value |
SetPF |
Pointer to direct value | Function returning value |
Example: Using SetPV and SetPF
package main
import (
"fmt"
"github.com/yyle88/tern/zerotern"
)
func main() {
var value int
zerotern.SetPV(&value, 42)
fmt.Println(value) // Output: 42
value = 7
zerotern.SetPF(&value, func() int { return 99 })
fmt.Println(value) // Output: 7
}
Why Choose tern?
- Improved Readability: Simplifies conditional logic with concise and clear expressions.
- Performance Optimization: Lazy evaluation avoids unnecessary computations.
- Type Safety: Leverages Go’s generics for maximum flexibility and reliability.
- Versatility: Supports a wide range of scenarios, including pointer handling and zero-value fallbacks.
Contributing
Contributions are welcome! Feel free to report issues, suggest improvements, or submit pull requests on GitHub.
License
MIT License. See LICENSE.
Contributing
Feel free to contribute or improve the package! Stars and pull requests are always welcome!
Thank you for using tern!
GitHub Stars
Give me stars! Thank you!!!
Documentation
¶
Index ¶
- func BF[T any](condition bool, a func() T) T
- func BFF[T any](condition bool, a func() T, b func() T) T
- func BFV[T any](condition bool, a func() T, b T) T
- func BV[T any](condition bool, a T) T
- func BVF[T any](condition bool, a T, b func() T) T
- func BVV[T any](condition bool, a, b T) T
- func FF[T any](condition func() bool, a func() T) T
- func FFF[T any](condition func() bool, a func() T, b func() T) T
- func FFV[T any](condition func() bool, a func() T, b T) T
- func FV[T any](condition func() bool, a T) T
- func FVF[T any](condition func() bool, a T, b func() T) T
- func FVV[T any](condition func() bool, a, b T) T
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
This section is empty.
Source Files
Directories