ref

package
v1.0.225 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 6, 2026 License: MIT Imports: 0 Imported by: 4

Documentation

Overview

Package ref provides a utility function for creating a pointer to a value. It is designed to simplify the process of obtaining a pointer to a value of any type.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Of

func Of[E any](e E) *E

Of creates a pointer to the provided value of type 'E'. The primary purpose of this function is to simplify the creation of pointers to values without needing to use temporary variables.

Copy hazard: the argument is passed by value, so Of returns a pointer to a fresh copy, not to the caller's original variable. Do not use Of with types that must not be copied after first use (e.g. sync.Mutex, sync.WaitGroup, strings.Builder, or any struct embedding such a type, including g's *Mutex/*RwLock/*Builder) — the copy may carry stale internal state and `go vet` will not flag it here. Take the address of the original value instead.

Parameters:

e: The value of type 'E' to create a pointer for.

Returns:

*E: A pointer to a copy of the provided value 'e'.

Example usage:

intValue := 42
intPtr := ref.Of(intValue)
fmt.Println(*intPtr)

Types

This section is empty.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL