generichelper

README

generichelper

Helpers for Go's generics.

Documentation

Overview

Package generichelper contains generics-related helpers.

Index

• func DeepEqual[T any](x, y T) bool
• func Is[T any](x any) bool
• func IsNoType[T any]() bool
• func IsZeroValue[T any](t T) bool
• func SameType[T, O any]() bool
• func Ternary[T any](condition bool, trueT, falseT T) T
• func TypeHoldsType[T, O any]() bool
• func TypeMeetsType[T, O any]() bool
• func TypeOf[T any]() reflect.Type
• func ZeroValue[T any]() T
• type NoType
• type Tuple2
  • func NewTuple2[T1, T2 any](item1 T1, item2 T2) Tuple2[T1, T2]

Examples

• NoType
• SameType (String)

Functions

func DeepEqual

func DeepEqual[T any](x, y T) bool

DeepEqual is a generic wrapper around reflect.DeepEqual.

func Is

func Is[T any](x any) bool

Is determines whether 'x' is of type T.

func IsNoType

func IsNoType[T any]() bool

IsNoType determines whether T's type is NoType.

func IsZeroValue

func IsZeroValue[T any](t T) bool

IsZeroValue determines whether 't' is of zero value.

func SameType

func SameType[T, O any]() bool

SameType determines whether T's and O's types are the same.

Example (String)

fmt.Println(SameType[string, NoType]())
fmt.Println(SameType[string, string]())
fmt.Println(SameType[int, string]())
type s2 = string
fmt.Println(SameType[string, s2]())
type s3 string
fmt.Println(SameType[s3, string]())

Output:

false
true
false
true
false

func Ternary

func Ternary[T any](condition bool, trueT, falseT T) T

Ternary mimics ternary conditional operation.

func TypeHoldsType

func TypeHoldsType[T, O any]() bool

TypeHoldsType reports whether type T holds other type O.

TypeHoldsType returns 'true' if:

• type assertion T.(O) holds or
• type T implements interface type O.

Otherwise, TypeHoldsType returns 'false'.

func TypeMeetsType

func TypeMeetsType[T, O any]() bool

TypeMeetsType returns 'true' if:

• TypeHoldsType returns 'true' or
• type T can be converted to type O.

Otherwise, TypeMeetsType returns 'false'.

func TypeOf

func TypeOf[T any]() reflect.Type

TypeOf returns T's reflect.Type.

Deprecated: Use reflect.TypeFor instead.

func ZeroValue

func ZeroValue[T any]() T

ZeroValue returns T's zero value.

Types

type NoType

type NoType struct{}

NoType is a sentinel type to denote that this type parameter needs not to be processed (see ExampleNoType). NoType may be used to instantiate type parameter with 'any' or 'comparable' type constraint only.

Example

fmt.Println(testNoType_any[NoType]())
fmt.Println(testNoType_any[struct{}]())
fmt.Println(testNoType_comparable[NoType]())
fmt.Println(testNoType_comparable[int]())

Output:

NoType
struct
NoType
int

type Tuple2

type Tuple2[T1, T2 any] struct {
	Item1 T1
	Item2 T2
}

Tuple2 represents a 2-tuple, or pair.

func NewTuple2

func NewTuple2[T1, T2 any](item1 T1, item2 T2) Tuple2[T1, T2]

NewTuple2 creates Tuple2.