How do I represent an Optional String in Go?

by

A logical solution would be to use *string as mentioned by Ainar-G. This other answer details the possibilities of obtaining a pointer to a value (int64 but the same works for string too). A wrapper is another solution.

Using just string

An optional string means a string plus 1 specific value (or state) saying “not a string” (but a null).

This 1 specific value can be stored (signaled) in another variable (e.g bool) and you can pack the string and the bool into a struct and we arrived to the wrapper, but this doesn’t fit into the case of “using just a string” (but is still a viable solution).

If we want to stick to just a string, we can take out 1 specific value from the possible values of a string type (which has “infinity” possible values as the length is not limited (or maybe it is as it must be an int but that’s all right)), and we can name this specific value the null value, the value which means “not a string”.

The most convenient value for indicating null is the zero value of string, which is the empty string: "". Designating this the null element has the convenience that whenever you create a string variable without explicitly specifying the initial value, it will be initialized with "". Also when querying an element from a map whose value is string will also yield "" if the key is not in the map.

This solution suits many real-life use-cases. If the optional string is supposed to be a person’s name for example, an empty string does not really mean a valid person name, so you shouldn’t allow that in the first place.

There might be cases of course when the empty string does represent a valid value of a variable of string type. For these use-cases we can choose another value.

In Go, a string is in effect a read-only slice of bytes. See blog post Strings, bytes, runes and characters in Go which explains this in details.

So a string is a byte slice, which is the UTF-8 encoded bytes in case of a valid text. Assuming you want to store a valid text in your optional string (if you wouldn’t, then you can just use a []byte instead which can have a nil value), you can choose a string value which represents an invalid UTF-8 byte sequence and thus you won’t even have to make a compromise to exclude a valid text from the possible values. The shortest invalid UTF-8 byte sequence is 1 byte only, for example 0xff (there are more). Note: you can use the utf8.ValidString() function to tell if a string value is a valid text (valid UTF-8 encoded byte sequence).

You can make this exceptional value a const:

const Null = "\xff"

Being this short also means it will be very fast to check if a string equals to this.
And by this convention you already have an optional string which also allows the empty string.

Try it on the Go Playground.

const Null = "\xff"

func main() {
    fmt.Println(utf8.ValidString(Null)) // false

    s := Null
    fmt.Println([]byte(s)) // [255]
    fmt.Println(s == Null) // true
    s = "notnull"
    fmt.Println(s == Null) // false
}

More Related Contents:

  1. How to compare strings in golang? [closed]
  2. Format a Go string without printing?
  3. Call functions with special prefix/suffix
  4. How to efficiently concatenate strings in go
  5. How to generate a random string of a fixed length in Go?
  6. Reading a file line by line in Go
  7. How to convert an int value to string in Go?
  8. h:inputText which is bound to String property is submitting empty string instead of null
  9. Convert string to integer type in Go?
  10. How do you write multiline strings in Go?
  11. []byte(string) vs []byte(*string)
  12. Replace empty strings with null values
  13. How can I read a whole file into a string variable
  14. Convert time.Time to string
  15. Convert slice of string to slice of pointer to string
  16. How to get the number of characters in a string
  17. Does conversion between alias types in Go create copies?
  18. How to compare strings in Bash
  19. What are the differences between Rust’s `String` and `str`?
  20. Does std::string have a null terminator?
  21. Android Intent.getStringExtra() returns null
  22. Finding the ranking of a word (permutations) with duplicate letters
  23. How can I sort a list of strings in Dart?
  24. Split a character vector into individual characters? (opposite of paste or stringr::str_c)
  25. Bash: manipulating with strings (percent sign)
  26. Remove last character from string. Swift language
  27. How to combine multiple character columns into a single column in an R data frame
  28. require file as string
  29. STRING to DATE in BIGQUERY
  30. How to split a string by a string in Scala

Leave a Comment