convert

README

convert 🚀

Type Conversion Sugar

It's not rocket science -- it's just a bunch of functions that convert from one type into another (very similar) type. I'm sure someone else out there has already done it, and probably better, too. You should use their library instead.

Pull Requests Welcome

This library is a work in progress, and will benefit from your experience reports, use cases, and contributions. If you have an idea for making this library better, send in a pull request. We're all in this together! 🚀

Documentation

Index

• func Bool(value any) bool
• func BoolDefault(value any, defaultValue bool) bool
• func BoolOk(value any, defaultValue bool) (bool, bool)
• func Bytes(value any) []byte
• func Element(original any) any
• func Float(value any) float64
• func FloatDefault(value any, defaultValue float64) float64
• func FloatOk(value any, defaultValue float64) (float64, bool)
• func HTTPHeader(value any) http.Header
• func HTTPHeaderOk(value any) (http.Header, bool)
• func Int(value any) int
• func Int64(value any) int64
• func Int64Default(value any, defaultValue int64) int64
• func Int64Ok(value any, defaultValue int64) (int64, bool)
• func IntDefault(value any, defaultValue int) int
• func IntOk(value any, defaultValue int) (int, bool)
• func Interface(value any) any
• func IsMap(value any) bool
• func IsSlice(value any) bool
• func JoinString(value any, delimiter string) string
• func MapOfAny(value any) map[string]any
• func MapOfAnyOk(value any) (map[string]any, bool)
• func MapOfSliceOfString(value any) map[string][]string
• func MapOfSliceOfStringOk(value any) (map[string][]string, bool)
• func MapOfString(value any) map[string]string
• func MapOfStringOk(value any) (map[string]string, bool)
• func NullBool(value any) null.Bool
• func NullFloat(value any) null.Float
• func NullInt(value any) null.Int
• func NullInt64(value any) null.Int64
• func Pointer[T any](original T) *T
• func ReflectType(value any) reflect.Type
• func ReflectValue(value any) reflect.Value
• func SliceLength(value any) int
• func SliceOfAny(value any) []any
• func SliceOfAnyOk(value any) ([]any, bool)
• func SliceOfFloat(value any) []float64
• func SliceOfFloatOk(value any) ([]float64, bool)
• func SliceOfInt(value any) []int
• func SliceOfInt64(value any) []int64
• func SliceOfInt64Ok(value any) ([]int64, bool)
• func SliceOfIntOk(value any) ([]int, bool)
• func SliceOfMap(value any) []map[string]any
• func SliceOfMapOk(value any) ([]map[string]any, bool)
• func SliceOfString(value any) []string
• func SliceOfStringOk(value any) ([]string, bool)
• func String(value any) string
• func StringDefault(value any, defaultValue string) string
• func StringOk(value any, defaultValue string) (string, bool)
• func Time(value any) time.Time
• func TimeDefault(value any, defaultValue time.Time) time.Time
• func TimeOk(value any, defaultValue time.Time) (time.Time, bool)
• func URLValues(value any) url.Values
• func URLValuesOk(value any) (url.Values, bool)
• type Booler
• type Floater
• type Hexer
• type Int64er
• type Inter
• type LengthGetter
• type MapOfAnyGetter
• type Nuller
• type Stringer
• type Timer

Functions

func Bool

func Bool(value any) bool

Bool forces a conversion from an arbitrary value into a boolean. If the value cannot be converted, then the default value for the type is used.

func BoolDefault

func BoolDefault(value any, defaultValue bool) bool

BoolDefault forces a conversion from an arbitrary value into a bool. if the value cannot be converted, then the default value is used.

func BoolOk

func BoolOk(value any, defaultValue bool) (bool, bool)

BoolOk converts an arbitrary value (passed in the first parameter) into a boolean, somehow, no matter what. The first result is the final converted value, or the default value (passed in the second parameter) The second result is TRUE if the value was naturally a bool, and FALSE otherwise

Conversion Rules: Nils return default value and Ok=false Bools are passed through with Ok=true Ints and Floats all convert to FALSE if they are zero, and TRUE if they are non-zero. In these cases, Ok=false String values of "true" and "false" convert normall, and Ok=true. All other strings return the default value, with Ok=false Known interfaces (Booler, Inter, Floater, Stringer) are handled like their corresponding types All other values return the default value with Ok=false

func Bytes

func Bytes(value any) []byte

Bytes forces a conversion from an arbitrary value into a slice of bytes.

func Element

func Element(original any) any

Element defreferences a pointer, if necessary, and returns the underlying value

func Float

func Float(value any) float64

Float forces a conversion from an arbitrary value into a float64. If the value cannot be converted, then the zero value for the type (false) is used.

func FloatDefault

func FloatDefault(value any, defaultValue float64) float64

FloatDefault forces a conversion from an arbitrary value into a float64. if the value cannot be converted, then the default value is used.

func FloatOk

func FloatOk(value any, defaultValue float64) (float64, bool)

FloatOk converts an arbitrary value (passed in the first parameter) into a float64, no matter what. The first result is the final converted value, or the default value (passed in the second parameter) The second result is TRUE if the value was naturally a floating point number, and FALSE otherwise

Conversion Rules: Nils and Bools return default value and Ok=false Ints and Floats are converted into float64, with Ok=true String values are attempted to parse as a float64. If unsuccessful, default value is returned. For all strings, Ok=false Known interfaces (Inter, Floater, Stringer) are handled like their corresponding types. All other values return the default value with Ok=false

func HTTPHeader

func HTTPHeader(value any) http.Header

HTTPHeader converts a data structure into a http.Header object, which is a specialized instance of a map[string][]string.

func HTTPHeaderOk

func HTTPHeaderOk(value any) (http.Header, bool)

HTTPHeader converts a data structure into a http.Header object, which is a specialized instance of a map[string][]string. It returns TRUE if the conversion was successful, and FALSE otherwise.

func Int

func Int(value any) int

Int forces a conversion from an arbitrary value into an int. If the value cannot be converted, then the zero value for the type (0) is used.

func Int64

func Int64(value any) int64

Int64 forces a conversion from an arbitrary value into an int. If the value cannot be converted, then the zero value for the type (0) is used.

func Int64Default

func Int64Default(value any, defaultValue int64) int64

Int64Default forces a conversion from an arbitrary value into a int. if the value cannot be converted, then the default value is used.

func Int64Ok

func Int64Ok(value any, defaultValue int64) (int64, bool)

Int64Ok converts an arbitrary value (passed in the first parameter) into an int, no matter what. The first result is the final converted value, or the default value (passed in the second parameter) The second result is TRUE if the value was naturally an integer, and FALSE otherwise

Conversion Rules: Nils and Bools return default value and Ok=false Int64s are returned directly with Ok=true Floats are truncated into ints. If there is no decimal value then Ok=true String values are attempted to parse as a int. If unsuccessful, default value is returned. For all strings, Ok=false Known interfaces (Int64er, Floater, Stringer) are handled like their corresponding types. All other values return the default value with Ok=false

func IntDefault

func IntDefault(value any, defaultValue int) int

IntDefault forces a conversion from an arbitrary value into a int. if the value cannot be converted, then the default value is used.

func IntOk

func IntOk(value any, defaultValue int) (int, bool)

IntOk converts an arbitrary value (passed in the first parameter) into an int, no matter what. The first result is the final converted value, or the default value (passed in the second parameter) The second result is TRUE if the value was naturally an integer, and FALSE otherwise

Conversion Rules: Nils and Bools return default value and Ok=false Ints are returned directly with Ok=true Floats are truncated into ints. If there is no decimal value then Ok=true String values are attempted to parse as a int. If unsuccessful, default value is returned. For all strings, Ok=false Known interfaces (Inter, Floater, Stringer) are handled like their corresponding types. All other values return the default value with Ok=false

func Interface

func Interface(value any) any

Interface returns the value of a reflect.Value. If the value is not already a reflect.Value, then it is returned as-is.

func IsMap

func IsMap(value any) bool

IsMap returns TRUE if the value is a map (Uses Reflection)

func IsSlice

func IsSlice(value any) bool

IsSlice returns TRUE if the value is a slice or array (Uses Reflection)

func JoinString

func JoinString(value any, delimiter string) string

func MapOfAny

func MapOfAny(value any) map[string]any

MapOfAny attempts to convert the generic value into a map[string]any

func MapOfAnyOk

func MapOfAnyOk(value any) (map[string]any, bool)

MapOfAnyOk attempts to convert the generic value into a map[string]any The boolean result value returns TRUE if successful. FALSE otherwise

func MapOfSliceOfString

func MapOfSliceOfString(value any) map[string][]string

MapOfSliceOfString converts the given value to a map[string][]string. If conversion is not possible, then an empty map is returned.

func MapOfSliceOfStringOk

func MapOfSliceOfStringOk(value any) (map[string][]string, bool)

MapOfSliceOfStringOk converts the given value to a map[string][]string. It returns TRUE if the conversion was successful. If conversion is not possible, then it returns an empty map and FALSE.

func MapOfString

func MapOfString(value any) map[string]string

MapOfString attempts to convert the generic value into a map[string]string

func MapOfStringOk

func MapOfStringOk(value any) (map[string]string, bool)

MapOfStringOk attempts to convert the generic value into a map[string]string The boolean result value returns TRUE if successful. FALSE otherwise

func NullBool

func NullBool(value any) null.Bool

NullBool converts a value into a nullable value. The value is only set if the input value is a natural match for this data type.

func NullFloat

func NullFloat(value any) null.Float

NullFloat converts a value into a nullable value. The value is only set if the input value is a natural match for this data type.

func NullInt

func NullInt(value any) null.Int

NullInt converts a value into a nullable value. The value is only set if the input value is a natural match for this data type.

func NullInt64

func NullInt64(value any) null.Int64

NullInt64 converts a value into a nullable value. The value is only set if the input value is a natural match for this data type.

func Pointer

func Pointer[T any](original T) *T

Pointer returns a pointer to the original value

func ReflectType

func ReflectType(value any) reflect.Type

ReflectType returns the reflect.Type of the given argument. If the argument is already a reflect.Type, then it is returned as-is.

func ReflectValue

func ReflectValue(value any) reflect.Value

ReflectValue returns the reflect.Value of the given argument. If the argument is already a reflect.Value, then it is returned as-is.

func SliceLength

func SliceLength(value any) int

SliceLength returns the length of any slice

func SliceOfAny

func SliceOfAny(value any) []any

SliceOfAny converts the value into a slice of any. It works with any, []any, []string, []int, []float64, string, int, and float64 values. If the passed value cannot be converted, then an empty slice is returned.

func SliceOfAnyOk

func SliceOfAnyOk(value any) ([]any, bool)

SliceOfAny converts the value into a slice of any. It works with any, []any, []string, []int, []float64, string, int, and float64 values. It returns TRUE if the conversion was successful, and FALSE otherwise.

func SliceOfFloat

func SliceOfFloat(value any) []float64

SliceOfFloat converts the value into a slice of floats. It works with any, []any, []float64, and float64 values. If the passed value cannot be converted, then an empty slice is returned.

func SliceOfFloatOk

func SliceOfFloatOk(value any) ([]float64, bool)

SliceOfFloat converts the value into a slice of floats. It works with any, []any, []float64, and float64 values. It returns TRUE if the conversion was successful, and FALSE otherwise.

func SliceOfInt

func SliceOfInt(value any) []int

SliceOfInt converts the value into a slice of ints. It works with any, []any, []string, []int, and int values. If the passed value cannot be converted, then an empty slice is returned.

func SliceOfInt64

func SliceOfInt64(value any) []int64

SliceOfInt64 converts the value into a slice of int64s. It works with any, []any, []string, []int, and int values. If the passed value cannot be converted, then an empty slice is returned.

func SliceOfInt64Ok

func SliceOfInt64Ok(value any) ([]int64, bool)

SliceOfInt64Ok converts the value into a slice of int64s. It works with float64, int, int64, string, and []any, []float64, []int, []int64, and []string values. It returns TRUE if the conversion was successful, and FALSE otherwise.

func SliceOfIntOk

func SliceOfIntOk(value any) ([]int, bool)

SliceOfIntOk converts the value into a slice of ints. It works with float, int, int, string, and []any, []float, []int, []int, and []string values. It returns TRUE if the conversion was successful, and FALSE otherwise.

func SliceOfMap

func SliceOfMap(value any) []map[string]any

SliceOfMap converts the value into a slice of map[string]any. It works with []any, []map[string]any. If the passed value cannot be converted, then an empty slice is returned.

func SliceOfMapOk

func SliceOfMapOk(value any) ([]map[string]any, bool)

SliceOfMapOk converts the value into a slice of map[string]any. It works with []any, []map[string]any, []map[string]string, and []MapOfAnyGetter. It returns TRUE if the conversion was successful, and FALSE otherwise.

func SliceOfString

func SliceOfString(value any) []string

SliceOfString converts the value into a slice of strings. It works with any, []any, []string, and string values. If the passed value cannot be converted, then an empty slice is returned.

func SliceOfStringOk

func SliceOfStringOk(value any) ([]string, bool)

SliceOfString converts the value into a slice of strings. It works with any, []any, []string, and string values. It returns TRUE if the value was converted successfullt, and FALSE otherwise.

func String

func String(value any) string

String forces a conversion from an arbitrary value into an string. If the value cannot be converted, then the default value for the type is used.

func StringDefault

func StringDefault(value any, defaultValue string) string

StringDefault forces a conversion from an arbitrary value into a string. if the value cannot be converted, then the default value is used.

func StringOk

func StringOk(value any, defaultValue string) (string, bool)

StringOk converts an arbitrary value (passed in the first parameter) into a string, no matter what. The first result is the final converted value, or the default value (passed in the second parameter) The second result is TRUE if the value was naturally a string, and FALSE otherwise

Conversion Rules: Nils return default value and Ok=false Bools are formated as "true" or "false" with Ok=false Ints are formated as strings with Ok=false Floats are formatted with 2 decimal places, with Ok=false String are passed through directly, with Ok=true Known interfaces (Inter, Floater, Stringer) are handled like their corresponding types. All other values return the default value with Ok=false

func Time

func Time(value any) time.Time

func TimeDefault

func TimeDefault(value any, defaultValue time.Time) time.Time

func TimeOk

func TimeOk(value any, defaultValue time.Time) (time.Time, bool)

func URLValues

func URLValues(value any) url.Values

URLValues converts a data structure into a url.Values object, which is a specialized instance of a map[string][]string.

func URLValuesOk

func URLValuesOk(value any) (url.Values, bool)

URLValues converts a data structure into a url.Values object, which is a specialized instance of a map[string][]string. It returns TRUE if the conversion was successful, and FALSE otherwise.

Types

type Booler

type Booler interface {

	// Bool returns the float64 value of the underlying object
	Bool() bool
}

Booler interface wraps the Bool() method that enables custom types to convert themselves to bool.

type Floater

type Floater interface {

	// Float returns the float64 value of the underlying object
	Float() float64
}

Floater interface wraps the Float() method that enables custom types to convert themselves to float64.

type Hexer

type Hexer interface {
	Hex() string
}

Hexer interface wraps the Hex() method that enables a custom type to convert itself into a hexadecimal string

type Int64er

type Int64er interface {

	// Int64 returns the int64 value of the underlying object
	Int64() int64
}

Int64er interface wraps the Int64() method that enables custom types to convert themselves to int64s.

type Inter

type Inter interface {

	// Int returns the int value of the underlying object
	Int() int
}

Inter interface wraps the Int() method that enables custom types to convert themselves to ints.

type LengthGetter

type LengthGetter interface {
	Length() int
}

Length interface wraps the Length() method that returns the length of an array or map

type MapOfAnyGetter

type MapOfAnyGetter interface {

	// MapOfAny returns the underlying data structure as a plain map[string]any
	MapOfAny() map[string]any
}

MapOfAnyGetter wraps the MapOfAny() method that returns a data structure as a MapOfAny

type Nuller

type Nuller interface {

	// IsNull returns TRUE if the underlying value is null
	IsNull() bool
}

Nuller wraps the IsNull interface (implemented by the null.* package) that enables custom types to declare that their value is null (zero)

type Stringer

type Stringer interface {

	// String returns the string value of the underlying object
	String() string
}

Stringer interface wraps the String() method that enables a custom type to convert themselves into strings.

type Timer

type Timer interface {
	// Time returns the time.Time value of the underlying object
	Time() time.Time
}

Timer interface wraps the Time() method that returns the time.Time value of the underlying object