ptr

Documentation

Overview

Package ptr provides generic utility functions for operating on/creating pointers.

Index

• func From[V any](v *V) V
• func SetIfNil[V any](p **V, otherP *V)
• func To[V any](v V) *V

Functions

func From

func From[V any](v *V) V

From dereferences the given pointer or returns the default value if <nil>, this mimics lots of the utility functions in the AWS SDK which do the same thing but were written before generics.

func SetIfNil

func SetIfNil[V any](p **V, otherP *V)

SetIfNil sets the first pointer to the other given pointer if first pointer is nil.

NOTE: This is a simple convenience function meant to replace the

if x == nil {
    x = y
}

code construction which takes 3 lines whilst calling this function takes one.

func To

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

To returns a pointer to a copy of the provided object.

NOTE: This is required for getting a pointer to a value that is defined as a Go constant (not the constant itself, passing it to a function will create a variable copy with the same value). For variables the pointer can be acquired directly using the & operator so there is no point in using this function in that case.