pointer

Documentation

Overview

Package pointer provides helper functions related to Go pointers.

Index

• func Copy[A any](a *A) *A
• func Eq[P Primitive](a, b *P) bool
• func Of[A any](a A) *A
• type Primitive

Functions

func Copy

func Copy[A any](a *A) *A

Copy returns a new pointer to a.

func Eq

func Eq[P Primitive](a, b *P) bool

Eq returns whether a and b are equal in underlying value.

May only be used on pointers to primitive types, where the comparison is guaranteed to be sensible. For complex types (i.e. structs) consider implementing an Equals method.

func Of

func Of[A any](a A) *A

Of returns a pointer to a.

Types

type Primitive

type Primitive interface {
	constraints.Ordered // just so happens to be the types we want
}

Primitive represents basic types that are safe to do basic comparisons by pointer dereference (checking nullity first).