Documentation
¶
Overview ¶
Example ¶
package main
import (
"fmt"
"github.com/ccoveille/go-safecast"
)
func main() {
var a int
a = 42
b, err := safecast.ToUint8(a) // everything is fine
if err != nil {
fmt.Println(err)
}
fmt.Println(b)
a = 255 + 1
_, err = safecast.ToUint8(a) // 256 is greater than uint8 maximum value
if err != nil {
fmt.Println(err)
}
a = -1
_, err = safecast.ToUint8(a) // -1 cannot fit in uint8
if err != nil {
fmt.Println(err)
}
str := "\x99" // ASCII code 153 for Trademark symbol
e := str[0]
_, err = safecast.ToInt8(e)
if err != nil {
fmt.Println(err)
}
}
Output: 42 conversion issue: 256 (int) is greater than 255 (uint8): maximum value for this type exceeded conversion issue: -1 (int) is less than 0 (uint8): minimum value for this type exceeded conversion issue: 153 (uint8) is greater than 127 (int8): maximum value for this type exceeded
Index ¶
- Variables
- func ToInt[T Type](i T) (int, error)
- func ToInt8[T Type](i T) (int8, error)
- func ToInt16[T Type](i T) (int16, error)
- func ToInt32[T Type](i T) (int32, error)
- func ToInt64[T Type](i T) (int64, error)
- func ToUint[T Type](i T) (uint, error)
- func ToUint8[T Type](i T) (uint8, error)
- func ToUint16[T Type](i T) (uint16, error)
- func ToUint32[T Type](i T) (uint32, error)
- func ToUint64[T Type](i T) (uint64, error)
- type Error
- type Float
- type Integer
- type Number
- type Signed
- type Type
- type Unsigned
Examples ¶
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func ToInt ¶
ToInt attempts to convert any Type value to an int. If the conversion results in a value outside the range of an int, an ErrConversionIssue error is returned.
Example ¶
package main
import (
"fmt"
"math"
"github.com/ccoveille/go-safecast"
)
func main() {
a := uint64(42)
i, err := safecast.ToInt(a)
if err != nil {
fmt.Println(err)
}
fmt.Println(i)
b := float32(math.MaxFloat32)
_, err = safecast.ToInt(b)
if err != nil {
fmt.Println(err)
}
}
Output: 42 conversion issue: 3.4028235e+38 (float32) is greater than 9223372036854775807 (int): maximum value for this type exceeded
func ToInt8 ¶
ToInt8 attempts to convert any Type value to an int8. If the conversion results in a value outside the range of an int8, an ErrConversionIssue error is returned.
Example ¶
package main
import (
"fmt"
"github.com/ccoveille/go-safecast"
)
func main() {
a := float64(42.42)
i, err := safecast.ToInt8(a)
if err != nil {
fmt.Println(err)
}
fmt.Println(i)
a = float64(200.42)
_, err = safecast.ToInt8(a)
if err != nil {
fmt.Println(err)
}
}
Output: 42 conversion issue: 200.42 (float64) is greater than 127 (int8): maximum value for this type exceeded
func ToInt16 ¶
ToInt16 attempts to convert any Type value to an int16. If the conversion results in a value outside the range of an int16, an ErrConversionIssue error is returned.
Example ¶
package main
import (
"fmt"
"github.com/ccoveille/go-safecast"
)
func main() {
a := int32(42)
i, err := safecast.ToInt16(a)
if err != nil {
fmt.Println(err)
}
fmt.Println(i)
a = int32(40000)
_, err = safecast.ToInt16(a)
if err != nil {
fmt.Println(err)
}
}
Output: 42 conversion issue: 40000 (int32) is greater than 32767 (int16): maximum value for this type exceeded
func ToInt32 ¶
ToInt32 attempts to convert any Type value to an int32. If the conversion results in a value outside the range of an int32, an ErrConversionIssue error is returned.
Example ¶
package main
import (
"fmt"
"math"
"github.com/ccoveille/go-safecast"
)
func main() {
a := int(42)
i, err := safecast.ToInt32(a)
if err != nil {
fmt.Println(err)
}
fmt.Println(i)
b := uint32(math.MaxInt32) + 1
_, err = safecast.ToInt32(b)
if err != nil {
fmt.Println(err)
}
}
Output: 42 conversion issue: 2147483648 (uint32) is greater than 2147483647 (int32): maximum value for this type exceeded
func ToInt64 ¶
ToInt64 attempts to convert any Type value to an int64. If the conversion results in a value outside the range of an int64, an ErrConversionIssue error is returned.
Example ¶
package main
import (
"fmt"
"math"
"github.com/ccoveille/go-safecast"
)
func main() {
a := uint64(42)
i, err := safecast.ToInt64(a)
if err != nil {
fmt.Println(err)
}
fmt.Println(i)
a = uint64(math.MaxInt64) + 1
_, err = safecast.ToInt64(a)
if err != nil {
fmt.Println(err)
}
}
Output: 42 conversion issue: 9223372036854775808 (uint64) is greater than 9223372036854775807 (int64): maximum value for this type exceeded
func ToUint ¶
ToUint attempts to convert any Type value to an uint. If the conversion results in a value outside the range of an uint, an ErrConversionIssue error is returned.
Example ¶
package main
import (
"fmt"
"github.com/ccoveille/go-safecast"
)
func main() {
a := int8(42)
i, err := safecast.ToUint(a)
if err != nil {
fmt.Println(err)
}
fmt.Println(i)
a = int8(-1)
_, err = safecast.ToUint(a)
if err != nil {
fmt.Println(err)
}
}
Output: 42 conversion issue: -1 (int8) is less than 0 (uint): minimum value for this type exceeded
func ToUint8 ¶
ToUint8 attempts to convert any Type value to an uint8. If the conversion results in a value outside the range of an uint8, an ErrConversionIssue error is returned.
Example ¶
package main
import (
"fmt"
"github.com/ccoveille/go-safecast"
)
func main() {
a := int64(42)
i, err := safecast.ToUint8(a)
if err != nil {
fmt.Println(err)
}
fmt.Println(i)
a = int64(-1)
_, err = safecast.ToUint8(a)
if err != nil {
fmt.Println(err)
}
}
Output: 42 conversion issue: -1 (int64) is less than 0 (uint8): minimum value for this type exceeded
func ToUint16 ¶
ToUint16 attempts to convert any Type value to an uint16. If the conversion results in a value outside the range of an uint16, an ErrConversionIssue error is returned.
Example ¶
package main
import (
"fmt"
"github.com/ccoveille/go-safecast"
)
func main() {
a := int64(42)
i, err := safecast.ToUint16(a)
if err != nil {
fmt.Println(err)
}
fmt.Println(i)
a = int64(-1)
_, err = safecast.ToUint16(a)
if err != nil {
fmt.Println(err)
}
}
Output: 42 conversion issue: -1 (int64) is less than 0 (uint16): minimum value for this type exceeded
func ToUint32 ¶
ToUint32 attempts to convert any Type value to an uint32. If the conversion results in a value outside the range of an uint32, an ErrConversionIssue error is returned.
Example ¶
package main
import (
"fmt"
"github.com/ccoveille/go-safecast"
)
func main() {
a := int16(42)
i, err := safecast.ToUint32(a)
if err != nil {
fmt.Println(err)
}
fmt.Println(i)
a = int16(-1)
_, err = safecast.ToUint32(a)
if err != nil {
fmt.Println(err)
}
}
Output: 42 conversion issue: -1 (int16) is less than 0 (uint32): minimum value for this type exceeded
func ToUint64 ¶
ToUint64 attempts to convert any Type value to an uint64. If the conversion results in a value outside the range of an uint64, an ErrConversionIssue error is returned.
Example ¶
package main
import (
"fmt"
"github.com/ccoveille/go-safecast"
)
func main() {
a := int8(42)
i, err := safecast.ToUint64(a)
if err != nil {
fmt.Println(err)
}
fmt.Println(i)
a = int8(-1)
_, err = safecast.ToUint64(a)
if err != nil {
fmt.Println(err)
}
}
Output: 42 conversion issue: -1 (int8) is less than 0 (uint64): minimum value for this type exceeded
Types ¶
type Number ¶
Number is an alias for all integers and floats TODO: consider using complex, but not sure there is a need
type Signed ¶ added in v1.1.0
Signed is an alias for all signed integers: int, int8, int16, int32, and int64 types.
