README
¶
Boolean Functions
- IsTrue: Checks if the provided string represents a true value (e.g., "T", "1", "TRUE").
- Toggle: Toggles the given boolean value, returning its negation. (e.g.,
truebecomesfalseand vice versa). - AllTrue: Checks if all the values in a slice of booleans are
true. Returnsfalseif the slice is empty. - AnyTrue: Checks if at least one value in a slice of booleans is
true. Returnsfalseif the slice is empty. - NoneTrue: Checks if none of the values in a slice of booleans are
true. Returnstrueif the slice is empty. - CountTrue: Counts the number of
truevalues in a slice of booleans. Returns0for an empty slice. - CountFalse: Counts the number of
falsevalues in a slice of booleans. Returns0for an empty slice. - Equal: Checks if all the values in a variadic boolean argument are equal. Returns
trueif the slice contains only one or no elements. - And: Performs a logical AND operation on all the values in a slice of booleans. Returns
trueonly if all values aretrue. Returnsfalsefor an empty slice. - Or: Performs a logical OR operation on all the values in a slice of booleans. Returns
trueif at least one value istrue. Returnsfalsefor an empty slice.
Examples:
For examples of each function, please checkout EXAMPLES.md
Documentation
¶
Overview ¶
Package boolean defines boolean helpers.
Index ¶
- func AllTrue(values []bool) bool
- func And(values []bool) bool
- func AnyTrue(values []bool) bool
- func CountFalse(values []bool) int
- func CountTrue(values []bool) int
- func Equal(values ...bool) bool
- func IsTrue(v string) bool
- func NoneTrue(values []bool) bool
- func Or(values []bool) bool
- func Toggle(value bool) bool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AllTrue ¶ added in v0.10.0
AllTrue checks if all values in the slice are true.
Returns:
- false if the slice is empty or contains at least one false value.
- true if all values are true.
func And ¶ added in v0.10.0
And performs a logical AND across all values in the slice.
Returns:
- false if the slice is empty or any value is false.
- true if all values are true.
func AnyTrue ¶ added in v0.10.0
AnyTrue checks if at least one value in the slice is true.
Returns:
- false if the slice is empty or contains no true values.
- true if at least one value is true.
func CountFalse ¶ added in v0.10.0
CountFalse counts the number of false values in the slice.
Returns:
- The number of elements in the slice that are false.
func CountTrue ¶ added in v0.10.0
CountTrue counts the number of true values in the slice.
Returns:
- The number of elements in the slice that are true.
func Equal ¶ added in v0.10.0
Equal checks if all values in the variadic argument list are equal.
Returns:
- true if all values are the same (either all true or all false).
- false if there is any inconsistency or the argument list is empty.
func IsTrue ¶
IsTrue checks if the provided string is a true value It accepts 1, t, T, TRUE, true, True. All other values are considered false.
func NoneTrue ¶ added in v0.10.0
NoneTrue checks if none of the values in the slice are true.
Returns:
- true if the slice is empty or contains no true values.
- false if at least one value is true.
Types ¶
This section is empty.
Source Files