boolean — boxed boolean value

github.com/go-composites/boolean (Go package Boolean, imported from the src/ sub-directory) boxes a Go bool behind the org's interface-first style, exposing truthiness as composite methods.

API

import Boolean "github.com/go-composites/boolean/src"

type Interface interface {
    ToGoBool() bool
    ToGoString() string
    IsTrue() bool
    IsFalse() bool
    Equal(Interface) Interface
    And(Interface) Interface
    Or(Interface) Interface
    Not() Interface
    Xor(Interface) Interface
    IsNull() bool
    Inspect() Inspect.Interface
}

func New(b bool) Interface
func True() Interface
func False() Interface

// Null-Object variant (honours the full Interface, never nil):
func Null() Interface

New(b) wraps the Go bool b.
True() is shorthand for New(true); False() is shorthand for New(false).

Member	Behaviour
`ToGoBool()`	Returns the underlying Go `bool`.
`ToGoString()`	Returns the value as a quoted string, e.g. `"true"` / `"false"`.
`IsTrue()`	Returns `true` when the boxed value is `true`.
`IsFalse()`	Returns `true` when the boxed value is `false` (the negation of `IsTrue()`).
`Equal(other)`	Returns a new `Boolean.Interface` boxing whether the two boxed values are equal.
`And(other)`	Returns a new `Boolean.Interface` boxing the logical AND of the receiver and `other`.
`Or(other)`	Returns a new `Boolean.Interface` boxing the logical OR of the receiver and `other`.
`Not()`	Returns a new `Boolean.Interface` boxing the logical negation of the receiver.
`Xor(other)`	Returns a new `Boolean.Interface` boxing the exclusive OR of the receiver and `other`.
`IsNull()`	Returns `false` for a real boolean (see the Null-Object note below).
`Inspect()`	Returns an `Inspect.Interface` describing the value (type, address, data).

Usage

b := Boolean.True()
fmt.Println(b.ToGoBool())   // true
fmt.Println(b.ToGoString()) // "true"

if b.Equal(Boolean.New(true)).IsTrue() {
    fmt.Println("both are true")
}

// Logical operators compose Boolean.Interface values:
Boolean.True().And(Boolean.False()).IsTrue() // false
Boolean.True().Or(Boolean.False()).IsTrue()  // true
Boolean.True().Not().IsTrue()                // false
Boolean.True().Xor(Boolean.True()).IsTrue()  // false

Null-Object variant

Boolean.Null() returns the Null-Object boolean: a placeholder that honours the full Interface without ever being nil. A null boolean is neither true nor false — both IsTrue() and IsFalse() return false, ToGoString() renders "null", and every logical operator (And, Or, Not, Xor, Equal) returns the null boolean. IsNull() returns true. Use it instead of a nil Boolean.Interface.

Structural truthiness recognised by array

IsTrue() bool is a structural signal. array's combinators treat any value carrying an IsTrue() bool method as truthy, and so accept a Boolean.Interface directly — matched by its method set rather than by an import. This is deliberate: array does not import boolean, which would create an array → boolean → inspect → string → array import cycle.

Dependencies

boolean depends only on its own inspect sub-package (github.com/go-composites/boolean/src/inspect); it pulls in no other composite.