tox

README

tox

tox is a simple library for rapid (and potentially lossy) type conversions. It is very helpful when trying to do quick conversions of interfaces when confidence in the quality of the value is high.

Installation

Checkout the repository and run:

go get github.com/tartabit/tox

Usage

import "github.com/tartabit/tox"

var myint = 5
var mystring = tox.ToString(myint)

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT

Documentation

Index

• Constants
• func CapitalizeString(s string) string
• func Deepcopy[T any](x T) (T, error)
• func FlattenMap(m map[string]any, delim string) map[string]any
• func IsArray(i any) bool
• func IsNumber(i any) bool
• func IsString(i any) bool
• func MapKeysToArray(m any) []any
• func ToBool(v interface{}) bool
• func ToBoolPtr(v interface{}) *bool
• func ToByte(v interface{}) byte
• func ToByteArray(v interface{}) []byte
• func ToFloat64(v interface{}) float64
• func ToFloat64Ptr(v interface{}) *float64
• func ToInt(v interface{}) int
• func ToInt64(v interface{}) int64
• func ToInt64Ptr(v interface{}) *int64
• func ToIntArray(v interface{}) []int
• func ToIntPtr(v interface{}) *int
• func ToJson(v interface{}) string
• func ToMapStringInterface(v interface{}) map[string]interface{}
• func ToMapStringString(v interface{}) map[string]string
• func ToPrettyDuration(v time.Duration, format StringFormat) string
• func ToPrettyJson(v interface{}) string
• func ToPtr[T any](a T) *T
• func ToString(v interface{}) string
• func ToStringArray(v interface{}) []string
• func ToStringOpts(v interface{}, options *Options) string
• func ToStringPtr(v interface{}) *string
• func ToStringPtrOpts(v interface{}, options *Options) *string
• func ToTime(v interface{}) time.Time
• func ToTimePtr(v interface{}) *time.Time
• func TriBool(b *bool) bool
• func TruncateByteArray(b []byte, length int) []byte
• func TruncateString(s string, length int) string
• type FieldDiff
• type Object
  • func NewObject(mi any) Object
  • func NewObjectFromDelimitedString(source string, pattern string, delim string) (Object, error)
  • func (o Object) Clone() Object
  • func (o Object) ConvertStructs()
  • func (o Object) Delete(key string)
  • func (o Object) Diff(other Object) ObjectDiff
  • func (o Object) Equals(other Object) bool
  • func (o Object) FieldCount() int
  • func (o Object) Flatten(delim string) Object
  • func (o Object) Get(key string) any
  • func (o Object) GetBool(key string, def bool) bool
  • func (o Object) GetBoolPtr(key string, def bool) *bool
  • func (o Object) GetBytes(key string, def []byte) []byte
  • func (o Object) GetFloat64(key string, def float64) float64
  • func (o Object) GetFloat64Ptr(key string, def float64) *float64
  • func (o Object) GetInt(key string, def int) int
  • func (o Object) GetIntPtr(key string, def int) *int
  • func (o Object) GetInto(key string, ret any) any
  • func (o Object) GetObject(key string) Object
  • func (o Object) GetObjectArray(key string) []Object
  • func (o Object) GetString(key string, def string) string
  • func (o Object) GetStringArray(key string, def []string) []string
  • func (o Object) GetTime(key string, def time.Time) time.Time
  • func (o Object) GetTimePtr(key string, def time.Time) *time.Time
  • func (o Object) JsonBytes(pretty bool) []byte
  • func (o Object) JsonString(pretty bool) string
  • func (o Object) Merge(other Object)
  • func (o Object) MergeMissing(other Object)
  • func (o Object) Move(from string, to string)
  • func (o Object) RemoveNaN()
  • func (o Object) Set(key string, value any)
  • func (o Object) SetIfNotExist(key string, value any)
  • func (o Object) SetNullIfNotExist(key string)
  • func (o Object) Unmarshal(field string, raw any)
• type ObjectDiff
• type Options
• type StringFormat

Constants

const (
	BlankString = "(blank)"
	Null        = "(null)"
)

Functions

func CapitalizeString

func CapitalizeString(s string) string

func Deepcopy

func Deepcopy[T any](x T) (T, error)

Deepcopy makes a deep copy of whatever gets passed in. It handles pretty much all known Go types (with the exception of channels, unsafe pointers, and functions). Note that this is a truly deep copy that will work it's way all the way to the leaves of the types--any pointer will be copied, any values in any slice or map will be deep copied, etc. Note: in order to avoid an infinite loop, we keep track of any pointers that we've run across. If we run into that pointer again, we don't make another deep copy of it; we just replace it with the copy we've already made. This also ensures that the cloned result is functionally equivalent to the original value.

func FlattenMap

func FlattenMap(m map[string]any, delim string) map[string]any

func IsArray

func IsArray(i any) bool

func IsNumber

func IsNumber(i any) bool

func IsString

func IsString(i any) bool

func MapKeysToArray

func MapKeysToArray(m any) []any

func ToBool

func ToBool(v interface{}) bool

ToBool converts any data type to a bool, if the conversion fails, it returns false.

func ToBoolPtr

func ToBoolPtr(v interface{}) *bool

func ToByte

func ToByte(v interface{}) byte

func ToByteArray

func ToByteArray(v interface{}) []byte

ToByteArray converts bool, string, or byte arrays, if the conversion fails, it returns false.

func ToFloat64

func ToFloat64(v interface{}) float64

ToFloat64 converts any data type to a float64, if the conversion fails, it returns NaN.

func ToFloat64Ptr

func ToFloat64Ptr(v interface{}) *float64

func ToInt

func ToInt(v interface{}) int

ToInt converts any data type to a bool, if the conversion fails, it returns 0.

func ToInt64

func ToInt64(v interface{}) int64

ToInt converts any data type to a int64, if the conversion fails, it returns 0.

func ToInt64Ptr

func ToInt64Ptr(v interface{}) *int64

func ToIntArray

func ToIntArray(v interface{}) []int

func ToIntPtr

func ToIntPtr(v interface{}) *int

func ToJson

func ToJson(v interface{}) string

func ToMapStringInterface

func ToMapStringInterface(v interface{}) map[string]interface{}

func ToMapStringString

func ToMapStringString(v interface{}) map[string]string

ToMapStringString converts a generic map[string]interface{} to a map[string]string.

func ToPrettyDuration

func ToPrettyDuration(v time.Duration, format StringFormat) string

func ToPrettyJson

func ToPrettyJson(v interface{}) string

func ToPtr

func ToPtr[T any](a T) *T

func ToString

func ToString(v interface{}) string

ToString converts any data type to a string, it uses fmt.Sprintf() to convert unknown types.

func ToStringArray

func ToStringArray(v interface{}) []string

ToStringArray can convert a single string to an array, useful if interface could be a string or array of strings.

func ToStringOpts

func ToStringOpts(v interface{}, options *Options) string

func ToStringPtr

func ToStringPtr(v interface{}) *string

func ToStringPtrOpts

func ToStringPtrOpts(v interface{}, options *Options) *string

func ToTime

func ToTime(v interface{}) time.Time

ToTime converts data types to time.Time structures. 'int' or 'int64' are treated as unix time, strings are treated as RFC3330Nano timestamps. If the conversion fails, an empty time.Time{} is returned.

func ToTimePtr

func ToTimePtr(v interface{}) *time.Time

func TriBool

func TriBool(b *bool) bool

func TruncateByteArray

func TruncateByteArray(b []byte, length int) []byte

func TruncateString

func TruncateString(s string, length int) string

Types

type FieldDiff

type FieldDiff struct {
	Old any `json:"old" bson:"old"`
	New any `json:"new" bson:"new"`
}

type Object

type Object map[string]any

func NewObject

func NewObject(mi any) Object

func NewObjectFromDelimitedString

func NewObjectFromDelimitedString(source string, pattern string, delim string) (Object, error)

func (Object) Clone

func (o Object) Clone() Object

func (Object) ConvertStructs

func (o Object) ConvertStructs()

func (Object) Delete

func (o Object) Delete(key string)

func (Object) Diff

func (o Object) Diff(other Object) ObjectDiff

func (Object) Equals

func (o Object) Equals(other Object) bool

func (Object) FieldCount

func (o Object) FieldCount() int

func (Object) Flatten

func (o Object) Flatten(delim string) Object

func (Object) Get

func (o Object) Get(key string) any

func (Object) GetBool

func (o Object) GetBool(key string, def bool) bool

func (Object) GetBoolPtr

func (o Object) GetBoolPtr(key string, def bool) *bool

func (Object) GetBytes

func (o Object) GetBytes(key string, def []byte) []byte

func (Object) GetFloat64

func (o Object) GetFloat64(key string, def float64) float64

func (Object) GetFloat64Ptr

func (o Object) GetFloat64Ptr(key string, def float64) *float64

func (Object) GetInt

func (o Object) GetInt(key string, def int) int

func (Object) GetIntPtr

func (o Object) GetIntPtr(key string, def int) *int

func (Object) GetInto

func (o Object) GetInto(key string, ret any) any

func (Object) GetObject

func (o Object) GetObject(key string) Object

func (Object) GetObjectArray

func (o Object) GetObjectArray(key string) []Object

func (Object) GetString

func (o Object) GetString(key string, def string) string

func (Object) GetStringArray

func (o Object) GetStringArray(key string, def []string) []string

func (Object) GetTime

func (o Object) GetTime(key string, def time.Time) time.Time

func (Object) GetTimePtr

func (o Object) GetTimePtr(key string, def time.Time) *time.Time

func (Object) JsonBytes

func (o Object) JsonBytes(pretty bool) []byte

func (Object) JsonString

func (o Object) JsonString(pretty bool) string

func (Object) Merge

func (o Object) Merge(other Object)

func (Object) MergeMissing

func (o Object) MergeMissing(other Object)

func (Object) Move

func (o Object) Move(from string, to string)

func (Object) RemoveNaN

func (o Object) RemoveNaN()

func (Object) Set

func (o Object) Set(key string, value any)

func (Object) SetIfNotExist

func (o Object) SetIfNotExist(key string, value any)

func (Object) SetNullIfNotExist

func (o Object) SetNullIfNotExist(key string)

func (Object) Unmarshal

func (o Object) Unmarshal(field string, raw any)

type ObjectDiff

type ObjectDiff struct {
	Same     bool                 `json:"same"               bson:"same"`
	Added    Object               `json:"added,omitempty"    bson:"added,omitempty"`
	Modified map[string]FieldDiff `json:"modified,omitempty" bson:"modified,omitempty"`
	Deleted  Object               `json:"deleted,omitempty"  bson:"deleted,omitempty"`
}

type Options

type Options struct {
	EmptyStringAsNull bool
	FloatPrecision    int
	FloatToInt        bool
}

type StringFormat

type StringFormat int

const (
	FormatShort  StringFormat = 1
	FormatMedium StringFormat = 2
	FormatLong   StringFormat = 3
)