package null import ( "bytes" "database/sql" "encoding/json" "errors" "fmt" "strconv" ) // Int is an nullable int64. // It does not consider zero values to be null. // It will decode to null, not zero, if null. type Int struct { sql.NullInt64 } // NewInt creates a new Int func NewInt(i int64, valid bool) Int { return Int{ NullInt64: sql.NullInt64{ Int64: i, Valid: valid, }, } } // IntFrom creates a new Int that will always be valid. func IntFrom(i int64) Int { return NewInt(i, true) } // IntFromPtr creates a new Int that be null if i is nil. func IntFromPtr(i *int64) Int { if i == nil { return NewInt(0, false) } return NewInt(*i, true) } // ValueOrZero returns the inner value if valid, otherwise zero. func (i Int) ValueOrZero() int64 { if !i.Valid { return 0 } return i.Int64 } // UnmarshalJSON implements json.Unmarshaler. // It supports number, string, and null input. // 0 will not be considered a null Int. func (i *Int) UnmarshalJSON(data []byte) error { if bytes.Equal(data, nullBytes) { i.Valid = false return nil } if err := json.Unmarshal(data, &i.Int64); err != nil { var typeError *json.UnmarshalTypeError if errors.As(err, &typeError) { // special case: accept string input if typeError.Value != "string" { return fmt.Errorf("null: JSON input is invalid type (need int or string): %w", err) } var str string if err := json.Unmarshal(data, &str); err != nil { return fmt.Errorf("null: couldn't unmarshal number string: %w", err) } n, err := strconv.ParseInt(str, 10, 64) if err != nil { return fmt.Errorf("null: couldn't convert string to int: %w", err) } i.Int64 = n i.Valid = true return nil } return fmt.Errorf("null: couldn't unmarshal JSON: %w", err) } i.Valid = true return nil } // UnmarshalText implements encoding.TextUnmarshaler. // It will unmarshal to a null Int if the input is blank. // It will return an error if the input is not an integer, blank, or "null". func (i *Int) UnmarshalText(text []byte) error { str := string(text) if str == "" || str == "null" { i.Valid = false return nil } var err error i.Int64, err = strconv.ParseInt(string(text), 10, 64) if err != nil { return fmt.Errorf("null: couldn't unmarshal text: %w", err) } i.Valid = true return nil } // MarshalJSON implements json.Marshaler. // It will encode null if this Int is null. func (i Int) MarshalJSON() ([]byte, error) { if !i.Valid { return []byte("null"), nil } return []byte(strconv.FormatInt(i.Int64, 10)), nil } // MarshalText implements encoding.TextMarshaler. // It will encode a blank string if this Int is null. func (i Int) MarshalText() ([]byte, error) { if !i.Valid { return []byte{}, nil } return []byte(strconv.FormatInt(i.Int64, 10)), nil } // SetValid changes this Int's value and also sets it to be non-null. func (i *Int) SetValid(n int64) { i.Int64 = n i.Valid = true } // Ptr returns a pointer to this Int's value, or a nil pointer if this Int is null. func (i Int) Ptr() *int64 { if !i.Valid { return nil } return &i.Int64 } // IsZero returns true for invalid Ints, for future omitempty support (Go 1.4?) // A non-null Int with a 0 value will not be considered zero. func (i Int) IsZero() bool { return !i.Valid } // Equal returns true if both ints have the same value or are both null. func (i Int) Equal(other Int) bool { return i.Valid == other.Valid && (!i.Valid || i.Int64 == other.Int64) }