package null import ( "bytes" "database/sql" "encoding/json" "errors" "fmt" ) // Bool is a nullable bool. // It does not consider false values to be null. // It will decode to null, not false, if null. type Bool struct { sql.NullBool } // NewBool creates a new Bool func NewBool(b bool, valid bool) Bool { return Bool{ NullBool: sql.NullBool{ Bool: b, Valid: valid, }, } } // BoolFrom creates a new Bool that will always be valid. func BoolFrom(b bool) Bool { return NewBool(b, true) } // BoolFromPtr creates a new Bool that will be null if f is nil. func BoolFromPtr(b *bool) Bool { if b == nil { return NewBool(false, false) } return NewBool(*b, true) } // ValueOrZero returns the inner value if valid, otherwise false. func (b Bool) ValueOrZero() bool { return b.Valid && b.Bool } // UnmarshalJSON implements json.Unmarshaler. // It supports number and null input. // 0 will not be considered a null Bool. func (b *Bool) UnmarshalJSON(data []byte) error { if bytes.Equal(data, nullBytes) { b.Valid = false return nil } if err := json.Unmarshal(data, &b.Bool); err != nil { return fmt.Errorf("null: couldn't unmarshal JSON: %w", err) } b.Valid = true return nil } // UnmarshalText implements encoding.TextUnmarshaler. // It will unmarshal to a null Bool if the input is blank. // It will return an error if the input is not an integer, blank, or "null". func (b *Bool) UnmarshalText(text []byte) error { str := string(text) switch str { case "", "null": b.Valid = false return nil case "true": b.Bool = true case "false": b.Bool = false default: return errors.New("null: invalid input for UnmarshalText:" + str) } b.Valid = true return nil } // MarshalJSON implements json.Marshaler. // It will encode null if this Bool is null. func (b Bool) MarshalJSON() ([]byte, error) { if !b.Valid { return []byte("null"), nil } if !b.Bool { return []byte("false"), nil } return []byte("true"), nil } // MarshalText implements encoding.TextMarshaler. // It will encode a blank string if this Bool is null. func (b Bool) MarshalText() ([]byte, error) { if !b.Valid { return []byte{}, nil } if !b.Bool { return []byte("false"), nil } return []byte("true"), nil } // SetValid changes this Bool's value and also sets it to be non-null. func (b *Bool) SetValid(v bool) { b.Bool = v b.Valid = true } // Ptr returns a pointer to this Bool's value, or a nil pointer if this Bool is null. func (b Bool) Ptr() *bool { if !b.Valid { return nil } return &b.Bool } // IsZero returns true for invalid Bools, for future omitempty support (Go 1.4?) // A non-null Bool with a 0 value will not be considered zero. func (b Bool) IsZero() bool { return !b.Valid } // Equal returns true if both booleans have the same value or are both null. func (b Bool) Equal(other Bool) bool { return b.Valid == other.Valid && (!b.Valid || b.Bool == other.Bool) }