conv

Go Package: conv

Get:

go get -u github.com/cstockton/go-conv

Example:

// Basic types
if got, err := conv.Bool(`TRUE`); err == nil {
	fmt.Printf("conv.Bool(`TRUE`)\n  -> %v\n", got)
}
if got, err := conv.Duration(`1m2s`); err == nil {
	fmt.Printf("conv.Duration(`1m2s`)\n  -> %v\n", got)
}
var date time.Time
err := conv.Infer(&date, `Sat Mar 7 11:06:39 PST 2015`)
fmt.Printf("conv.Infer(&date, `Sat Mar 7 11:06:39 PST 2015`)\n  -> %v\n", got)

Output:

conv.Bool(`TRUE`)
  -> true
conv.Duration(`1m2s`)
  -> 1m2s
conv.Infer(&date, `Sat Mar 7 11:06:39 PST 2015`)
  -> 2015-03-07 11:06:39 +0000 PST

Intro

Notice: If you begin getting compilation errors use the v1 import path gopkg.in/cstockton/go-conv.v1 for an immediate fix and to future-proof.

Package conv provides fast and intuitive conversions across Go types. This library uses reflection to be robust but will bypass it for common conversions, for example string conversion to any type will never use reflection. All functions are safe for concurrent use by multiple Goroutines.

Overview

All conversion functions accept any type of value for conversion, if unable to find a reasonable conversion path they will return the target types zero value and an error.

Example:

// The zero value and a non-nil error is returned on failure.
fmt.Println(conv.Int("Foo"))

// Conversions are allowed as long as the underlying type is convertable, for
// example:
type MyString string
fmt.Println(conv.Int(MyString("42"))) // 42, nil

// Pointers will be dereferenced when appropriate.
str := "42"
fmt.Println(conv.Int(&str)) // 42, nil

// You may infer values from the base type of a pointer, giving you one
// function signature for all conversions. This may be convenient when the
// types are not known until runtime and reflection must be used.
var val int
err := conv.Infer(&val, `42`)
fmt.Println(val, err) // 42, nil

Output:

0 cannot convert "Foo" (type string) to int
42 <nil>
42 <nil>
42 <nil>

Bool

Bool conversion supports all the paths provided by the standard libraries strconv.ParseBool when converting from a string, all other conversions are simply true when not the types zero value. As a special case zero length map and slice types are also false, even if initialized.

Example:

// Bool conversion from other bool values will be returned without
// modification.
fmt.Println(conv.Bool(true))
fmt.Println(conv.Bool(false))

// Bool conversion from strings consider the following values true:
//   "t", "T", "true", "True", "TRUE",
// 	 "y", "Y", "yes", "Yes", "YES", "1"
//
// It considers the following values false:
//   "f", "F", "false", "False", "FALSE",
//   "n", "N", "no", "No", "NO", "0"
fmt.Println(conv.Bool("T"))
fmt.Println(conv.Bool("False"))

// Bool conversion from other supported types will return true unless it is
// the zero value for the given type.
fmt.Println(conv.Bool(int64(123)))
fmt.Println(conv.Bool(int64(0)))
fmt.Println(conv.Bool(time.Duration(123)))
fmt.Println(conv.Bool(time.Duration(0)))
fmt.Println(conv.Bool(time.Now()))
fmt.Println(conv.Bool(time.Time{}))

// All other types will return false.
fmt.Println(conv.Bool(struct{ string }{""}))

Output:

true <nil>
false <nil>
true <nil>
false <nil>
true <nil>
false <nil>
true <nil>
false <nil>
true <nil>
false <nil>
false cannot convert struct { string }{string:""} (type struct { string }) to bool

Duration

Duration conversion supports all the paths provided by the standard libraries time.ParseDuration when converting from strings, with a couple enhancements outlined below.

Example:

// Duration conversion from strings will first attempt to parse as a Go
// duration value using ParseDuration, then fall back to numeric conventions.
fmt.Println(conv.Duration("1h1m100ms"))     // 1h1m0.1s
fmt.Println(conv.Duration("3660100000000")) // 1h1m0.1s

// Numeric conversions directly convert to time.Duration nanoseconds.
fmt.Println(conv.Duration(3660100000000)) // 1h1m0.1s

// Floats deviate from the numeric conversion rules, instead
// separating the integer and fractional portions into seconds.
fmt.Println(conv.Duration("3660.10"))        // 1h1m0.1s
fmt.Println(conv.Duration(float64(3660.10))) // 1h1m0.1s

// Complex numbers are Float conversions using the real number.
fmt.Println(conv.Duration(complex(3660.10, 0))) // 1h1m0.1s

// Duration conversion from time.Duration and any numerical type will be
// converted using a standard Go conversion. This includes strings
fmt.Println(conv.Duration(time.Nanosecond)) // 1s
fmt.Println(conv.Duration(byte(1)))         // 1ns

Output:

1h1m0.1s <nil>
1h1m0.1s <nil>
1h1m0.1s <nil>
1h1m0.1s <nil>
1h1m0.1s <nil>
1h1m0.1s <nil>
1ns <nil>
1ns <nil>

Float64

Float64 conversion from other float values of an identical type will be returned without modification. Float64 from other types follow the general numeric rules.

Example:

fmt.Println(conv.Float64(float64(123.456))) // 123.456
fmt.Println(conv.Float64("-123.456"))       // -123.456
fmt.Println(conv.Float64("1.7976931348623157e+308"))

Output:

123.456 <nil>
-123.456 <nil>
1.7976931348623157e+308 <nil>

Infer

Infer will perform conversion by inferring the conversion operation from a pointer to a supported T of the into param. Since the value is assigned directly only a error value is returned, meaning no type assertions needed.

Example:

// Infer requires a pointer to all types.
var into int
if err := conv.Infer(into, `42`); err != nil {
	fmt.Println(err)
}
if err := conv.Infer(&into, `42`); err == nil {
	fmt.Println(into)
}

// Same as above but using new()
truth := new(bool)
if err := conv.Infer(truth, `TRUE`); err != nil {
	fmt.Println("Failed!")

Output:

cannot infer conversion for unchangeable 0 (type int)
42

Int

Int conversions follow the the general numeric rules.

Example:

fmt.Println(conv.Uint("123.456"))               // 123
fmt.Println(conv.Uint("-123.456"))              // 0
fmt.Println(conv.Uint8(uint64(math.MaxUint64))) // 255

Output:

123 <nil>
0 <nil>
255 <nil>

String

String conversion from any values outside the cases below will simply be the result of calling fmt.Sprintf("%v", value), meaning it can not fail. An error is still provided and you should check it to be future proof.

Example:

// String conversion from other string values will be returned without
// modification.
fmt.Println(conv.String("Foo"))

// As a special case []byte will also be returned after a Go string conversion
// is applied.
fmt.Println(conv.String([]byte("Foo")))

// String conversion from types that do not have a valid conversion path will
// still have sane string conversion for troubleshooting.
fmt.Println(conv.String(struct{ msg string }{"Foo"}))

Output:

Foo <nil>
Foo <nil>
{Foo} <nil>

Time

Time conversion from other time values will be returned without modification.

Example:

// Time conversion from other time.Time values will be returned without
// modification.
fmt.Println(`Times:`)
fmt.Println(conv.Time(time.Date(2006, 1, 2, 15, 4, 5, 0, time.UTC)))

// Time conversion from strings will be passed through time.Parse using a
// variety of formats. Strings that could not be parsed along with all other
// values will return an empty time.Time{} struct.
fmt.Println(`Strings:`)
formats := []string{
	`Mon, 02 Jan 2006 15:04:05`,
	`Mon, 02 Jan 2006 15:04:05 UTC`,
	`Mon, 2 Jan 2006 15:04:05`,
	`Mon, 2 Jan 2006 15:04:05 UTC`,
	`02 Jan 2006 15:04 UTC`,
	`2 Jan 2006 15:04:05`,
	`2 Jan 2006 15:04:05 UTC`,
}
for _, format := range formats {
	t, err := conv.Time(format)
	if err != nil {
		fmt.Println(`Conversion error: `, err)
	}
	fmt.Printf("%v <-- (%v)\n", t, format)
}

// Time conversion from types that do not have a valid conversion path will
// return the zero value and an error.
fmt.Println(`Errors:`)
fmt.Println(conv.Time(1))    // cannot convert 1 (type int) to time.Time
fmt.Println(conv.Time(true)) // cannot convert true (type bool) to time.Time

Output:

Times:
2006-01-02 15:04:05 +0000 UTC <nil>
Strings:
2006-01-02 15:04:05 +0000 UTC <-- (Mon, 02 Jan 2006 15:04:05)
2006-01-02 15:04:05 +0000 UTC <-- (Mon, 02 Jan 2006 15:04:05 UTC)
2006-01-02 15:04:05 +0000 UTC <-- (Mon, 2 Jan 2006 15:04:05)
2006-01-02 15:04:05 +0000 UTC <-- (Mon, 2 Jan 2006 15:04:05 UTC)
2006-01-02 15:04:00 +0000 UTC <-- (02 Jan 2006 15:04 UTC)
2006-01-02 15:04:05 +0000 UTC <-- (2 Jan 2006 15:04:05)
2006-01-02 15:04:05 +0000 UTC <-- (2 Jan 2006 15:04:05 UTC)
Errors:
0001-01-01 00:00:00 +0000 UTC cannot convert 1 (type int) to time.Time
0001-01-01 00:00:00 +0000 UTC cannot convert true (type bool) to time.Time

Uint

Uint conversions follow the the general numeric rules.

Example:

fmt.Println(conv.Uint("123.456"))               // 123
fmt.Println(conv.Uint("-123.456"))              // 0
fmt.Println(conv.Uint8(uint64(math.MaxUint64))) // 255

Output:

123 <nil>
0 <nil>
255 <nil>

Numerics

Numeric conversion from other numeric values of an identical type will be returned without modification. Numeric conversions deviate slightly from Go when dealing with under/over flow. When performing a conversion operation that would overflow, we instead assign the maximum value for the target type. Similarly, conversions that would underflow are assigned the minimun value for that type, meaning unsigned integers are given zero values instead of spilling into large positive integers.

Example:

// For more natural Float -> Integer when the underlying value is a string.
// Conversion functions will always try to parse the value as the target type
// first. If parsing fails float parsing with truncation will be attempted.
fmt.Println(conv.Int("-123.456")) // -123

// This does not apply for unsigned integers if the value is negative. Instead
// performing a more intuitive (to the human) truncation to zero.
fmt.Println(conv.Uint("-123.456")) // 0

Output:

-123 <nil>
0 <nil>

Panics

In short, panics should not occur within this library under any circumstance. This obviously excludes any oddities that may surface when the runtime is not in a healthy state, i.e. uderlying system instability, memory exhaustion. If you are able to create a reproducible panic please file a bug report.

Example:

// The zero value for the target type is always returned.
fmt.Println(conv.Bool(nil))
fmt.Println(conv.Bool([][]int{}))
fmt.Println(conv.Bool((chan string)(nil)))
fmt.Println(conv.Bool((*interface{})(nil)))
fmt.Println(conv.Bool((*interface{})(nil)))
fmt.Println(conv.Bool((**interface{})(nil)))

Output:

false cannot convert <nil> (type <nil>) to bool
false <nil>
false <nil>
false cannot convert (*interface {})(nil) (type *interface {}) to bool
false cannot convert (*interface {})(nil) (type *interface {}) to bool
false cannot convert (**interface {})(nil) (type **interface {}) to bool

Contributing

Feel free to create issues for bugs, please ensure code coverage remains 100% with any pull requests.

Bugs and Patches

Feel free to report bugs and submit pull requests.

• bugs: https://github.com/cstockton/go-conv/issues
• patches: https://github.com/cstockton/go-conv/pulls