Why do 2 time structs with the same date and time return false when compared with ==?

by

time.Time is a struct. When you try to compare them with ==, quoting from the Spec: Comparison operator:

Struct values are comparable if all their fields are comparable. Two struct values are equal if their corresponding non-blank fields are equal.

So t1 == t2 will compare all the fields of the 2 Time struct values. The Time struct contains not just the second and nanosecond since a base time, it also contains the location as a pointer: *Location, so == will also compare the location fields. Comparing pointers:

Pointer values are comparable. Two pointer values are equal if they point to the same variable or if both have value nil. Pointers to distinct zero-size variables may or may not be equal.

And this is why comparing the times with == gives a false result: 2 locations may denote the same location even if their address is different, and this is your case.

To prove this:

fmt.Println("Locations:", t1.Location(), t2.Location())
fmt.Printf("Location pointers: %p %p\n", t1.Location(), t2.Location())
fmt.Println("Locations equal:", t1.Location() == t2.Location())

Output:

Locations: UTC UTC
Location pointers: 0x1e2100 0x1e6de0
Locations equal: false

This is documented in time.Time:

Note that the Go == operator compares not just the time instant but also the Location. Therefore, Time values should not be used as map or database keys without first guaranteeing that the identical Location has been set for all values, which can be achieved through use of the UTC or Local method.

If t1 and t2 would also contain the same *Location pointer, they would be equal even if compared with the == operator. This can be ensured by calling Time.UTC() or Time.Local() method on them which returns a time.Time value where the same location pointer (*Location) is used. Or by using the Time.In() method which will set the specified location pointer (after the proper conversion), e.g.:

t2 = t2.In(t1.Location())
fmt.Println("Locations:", t1.Location(), t2.Location())
fmt.Printf("Location pointers: %p %p\n", t1.Location(), t2.Location())
fmt.Println("Locations equal:", t1.Location() == t2.Location())
fmt.Println(t1 == t2)     // Now true
fmt.Println(t1.Equal(t2)) // Still true

Output:

Locations: UTC UTC
Location pointers: 0x1e2100 0x1e2100
Locations equal: true
true
true

Try it on the Go Playground.

More Related Contents:

  1. What is the correct way to retrieve length of an array added a field in nested struct in golang
  2. What are the use(s) for tags in Go?
  3. What are the use(s) for struct tags in Go?
  4. Generic Structs with Go
  5. How to access unexported struct fields
  6. package’s type cannot be used as the vendored package’s type
  7. How to set default values in Go structs
  8. Why are interfaces needed in Golang?
  9. Golang embedded struct type
  10. Conversion of time.Duration type microseconds value to milliseconds
  11. Struct in for loop initializer
  12. When do you embed mutex in struct in Go?
  13. time.Since() with months and years
  14. Go struct tags with underscore before function names
  15. How to clone a structure with unexported field?
  16. Why can’t I append to a slice that’s the property of a struct in golang?
  17. Sudden Increase in the number of goroutines after upgrade [closed]
  18. cancel a blocking operation in Go
  19. Relative imports in Go
  20. Parsing date/time strings which are not ‘standard’ formats
  21. What does (*[1
  22. How to update map values in Go
  23. How to get the directory of the currently running file?
  24. How to run test cases in a specified file?
  25. Using forked package import in Go
  26. go 1.8 plugin use custom interface
  27. What is a sensible way to layout a Go project [closed]
  28. How to verify JWT signature with JWK in Go?
  29. What’s the difference between pointer and value in struct?
  30. Handle maps with same key type but different value type

Leave a Comment