ptr

README

Pointer

This package provides some functions for pointer-based operations.

Documentation

Index

• func AllPtrFieldsNil(obj interface{}) bool
• func Deref[T any](ptr *T, def T) T
• func Equal[T comparable](a, b *T) bool
• func To[T any](v T) *T

Functions

func AllPtrFieldsNil

func AllPtrFieldsNil(obj interface{}) bool

AllPtrFieldsNil tests whether all pointer fields in a struct are nil. This is useful when, for example, an API struct is handled by plugins which need to distinguish "no plugin accepted this spec" from "this spec is empty".

This function is only valid for structs and pointers to structs. Any other type will cause a panic. Passing a typed nil pointer will return true.

func Deref

func Deref[T any](ptr *T, def T) T

Deref dereferences ptr and returns the value it points to if no nil, or else returns def.

func Equal

func Equal[T comparable](a, b *T) bool

Equal returns true if both arguments are nil or both arguments dereference to the same value.

func To

func To[T any](v T) *T

To returns a pointer to the given value.