Awesome Go

null

CategoryData Structures and Algorithms
SubcategoryNullable Types
Stars0

Nullable Go types that can be marshalled/unmarshalled to/from JSON

About null

Nullable Go types

Go Reference CircleCI Go Report Card

Description

This package provides nullable Go types for bool, float64, int64, int32, string and time.Time replacing sql.NullString, sql.NullInt64, ... that can be marshalled/unmarshalled to/from JSON.

Installation

To install "null", run go get within your project:

go get github.com/emvi/null

Note that from 1.3 on "null" requires Go version 1.13 or newer.

Usage

Here is a short example demonstrating the string type. The other types (int64, float64 and bool) work in the same manner.

package main

import (
    "encoding/json"
    "database/sql"
    "fmt"

    "github.com/emvi/null"
)

type NullableString struct {
    Value null.String `json:"value"`
}

func main() {
    str := NullableString{null.NewString("nullable string", true)}
    // or long version: str := NullableString{null.String{sql.NullString{String: "nullable string", Valid: true}}}
    
    data, _ := json.Marshal(str)
    fmt.Println(string(data)) // -> {"value": "nullable"}

    str.SetNil() // use str.SetValid("value") to set a value again
    data, _ = json.Marshal(str)
    fmt.Println(string(data)) // -> {"value": null}
}

Contribute

See CONTRIBUTING.md

License

MIT

Frequently Asked Questions

What is null?

null is a Data Structures and Algorithms library for the Go programming language. Nullable Go types that can be marshalled/unmarshalled to/from JSON

How do I install null?

Install null with the Go module system using `go get emvi/null`. Check the repository for the current installation instructions.

What category does null belong to?

null is listed under Data Structures and Algorithms, specifically Nullable Types.

← Back to Nullable Types