caster.go

package gocast

// Caster is an interface that provides methods for type casting and conversion.
// It includes methods for checking if a value is nil, retrieving the value as an interface,
// and converting the value to primary go types such as bool, int, uint, float, and string.
// Each type conversion method has a corresponding safe method that returns a fallback value
// in case of an error, and methods for converting to slices of each type.
type Caster interface {
	// IsNil checks if the value is nil.
	IsNil() bool

	// Interface returns the value as an interface{}.
	Interface() any

	// Unmarshal unmarshal value using json decoder.
	Unmarshal(out any) error

	// Bool converts the value to a bool.
	Bool() (bool, error)

	// BoolSafe converts the value to a bool, returning a fallback value in case of an error.
	BoolSafe(fallback bool) bool

	// Int converts the value to an int.
	Int() (int, error)

	// IntSafe converts the value to an int, returning a fallback value in case of an error.
	IntSafe(fallback int) int

	// Int8 converts the value to an int8.
	Int8() (int8, error)

	// Int8Safe converts the value to an int8, returning a fallback value in case of an error.
	Int8Safe(fallback int8) int8

	// Int16 converts the value to an int16.
	Int16() (int16, error)

	// Int16Safe converts the value to an int16, returning a fallback value in case of an error.
	Int16Safe(fallback int16) int16

	// Int32 converts the value to an int32.
	Int32() (int32, error)

	// Int32Safe converts the value to an int32, returning a fallback value in case of an error.
	Int32Safe(fallback int32) int32

	// Int64 converts the value to an int64.
	Int64() (int64, error)

	// Int64Safe converts the value to an int64, returning a fallback value in case of an error.
	Int64Safe(fallback int64) int64

	// Uint converts the value to a uint.
	Uint() (uint, error)

	// UintSafe converts the value to a uint, returning a fallback value in case of an error.
	UintSafe(fallback uint) uint

	// Uint8 converts the value to a uint8.
	Uint8() (uint8, error)

	// Uint8Safe converts the value to a uint8, returning a fallback value in case of an error.
	Uint8Safe(fallback uint8) uint8

	// Uint16 converts the value to a uint16.
	Uint16() (uint16, error)

	// Uint16Safe converts the value to a uint16, returning a fallback value in case of an error.
	Uint16Safe(fallback uint16) uint16

	// Uint32 converts the value to a uint32.
	Uint32() (uint32, error)

	// Uint32Safe converts the value to a uint32, returning a fallback value in case of an error.
	Uint32Safe(fallback uint32) uint32

	// Uint64 converts the value to a uint64.
	Uint64() (uint64, error)

	// Uint64Safe converts the value to a uint64, returning a fallback value in case of an error.
	Uint64Safe(fallback uint64) uint64

	// Float32 converts the value to a float32.
	Float32() (float32, error)

	// Float32Safe converts the value to a float32, returning a fallback value in case of an error.
	Float32Safe(fallback float32) float32

	// Float64 converts the value to a float64.
	Float64() (float64, error)

	// Float64Safe converts the value to a float64, returning a fallback value in case of an error.
	Float64Safe(fallback float64) float64

	// String converts the value to a string.
	String() (string, error)

	// StringSafe converts the value to a string, returning a fallback value in case of an error.
	StringSafe(fallback string) string

	// Slice returns the value as a slice of interface{}.
	Slice() ([]any, error)

	// Slice returns the value as a slice of interface{}.
	SliceSafe(fallback []any) []any

	// BoolSlice converts the value to a slice of bool.
	BoolSlice() ([]bool, error)

	// BoolSliceSafe converts the value to a slice of bool, returning a fallback value in case of an error.
	BoolSliceSafe(fallback []bool) []bool

	// IntSlice converts the value to a slice of int.
	IntSlice() ([]int, error)

	// IntSliceSafe converts the value to a slice of int, returning a fallback value in case of an error.
	IntSliceSafe(fallback []int) []int

	// Int8Slice converts the value to a slice of int8.
	Int8Slice() ([]int8, error)

	// Int8SliceSafe converts the value to a slice of int8, returning a fallback value in case of an error.
	Int8SliceSafe(fallback []int8) []int8

	// Int16Slice converts the value to a slice of int16.
	Int16Slice() ([]int16, error)

	// Int16SliceSafe converts the value to a slice of int16, returning a fallback value in case of an error.
	Int16SliceSafe(fallback []int16) []int16

	// Int32Slice converts the value to a slice of int32.
	Int32Slice() ([]int32, error)

	// Int32SliceSafe converts the value to a slice of int32, returning a fallback value in case of an error.
	Int32SliceSafe(fallback []int32) []int32

	// Int64Slice converts the value to a slice of int64.
	Int64Slice() ([]int64, error)

	// Int64SliceSafe converts the value to a slice of int64, returning a fallback value in case of an error.
	Int64SliceSafe(fallback []int64) []int64

	// UintSlice converts the value to a slice of uint.
	UintSlice() ([]uint, error)

	// UintSliceSafe converts the value to a slice of uint, returning a fallback value in case of an error.
	UintSliceSafe(fallback []uint) []uint

	// Uint8Slice converts the value to a slice of uint8.
	Uint8Slice() ([]uint8, error)

	// Uint8SliceSafe converts the value to a slice of uint8, returning a fallback value in case of an error.
	Uint8SliceSafe(fallback []uint8) []uint8

	// Uint16Slice converts the value to a slice of uint16.
	Uint16Slice() ([]uint16, error)

	// Uint16SliceSafe converts the value to a slice of uint16, returning a fallback value in case of an error.
	Uint16SliceSafe(fallback []uint16) []uint16

	// Uint32Slice converts the value to a slice of uint32.
	Uint32Slice() ([]uint32, error)

	// Uint32SliceSafe converts the value to a slice of uint32, returning a fallback value in case of an error.
	Uint32SliceSafe(fallback []uint32) []uint32

	// Uint64Slice converts the value to a slice of uint64.
	Uint64Slice() ([]uint64, error)

	// Uint64SliceSafe converts the value to a slice of uint64, returning a fallback value in case of an error.
	Uint64SliceSafe(fallback []uint64) []uint64

	// Float32Slice converts the value to a slice of float32.
	Float32Slice() ([]float32, error)

	// Float32SliceSafe converts the value to a slice of float32, returning a fallback value in case of an error.
	Float32SliceSafe(fallback []float32) []float32

	// Float64Slice converts the value to a slice of float64.
	Float64Slice() ([]float64, error)

	// Float64SliceSafe converts the value to a slice of float64, returning a fallback value in case of an error.
	Float64SliceSafe(fallback []float64) []float64

	// StringSlice converts the value to a slice of string.
	StringSlice() ([]string, error)

	// StringSliceSafe converts the value to a slice of string, returning a fallback value in case of an error.
	StringSliceSafe(fallback []string) []string
}

// NewCaster creates a new instance of a Caster with the provided value.
// The value can be of any type and will be used for type casting and conversion
// through the methods defined in the Caster interface.
//
// Parameters:
//   - v: The value to be used for type casting and conversion.
//
// Returns:
//   - Caster: An instance of the Caster interface that provides methods for type casting and conversion.
func NewCaster(v interface{}) Caster {
	return casterDriver{
		data: v,
	}
}