go.mway.dev/x@v0.0.0-20240520034138-950aede9a3fb/ptr/ptr.go

// Copyright (c) 2022 Matt Way
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to
// deal in the Software without restriction, including without limitation the
// rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
// sell copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS
// IN THE THE SOFTWARE.

// Package ptr provides pointer-related types and utilities.
package ptr

// Of returns a pointer of type T that points to a value of x. Users are
// responsible for ensuring that T has no prohibitive copy or value semantics
// (for example, noCopy or implicit sharing due to shallow copying).
func Of[T any](x T) *T {
	return &x
}

// From deferences x, returning the underlying value of type T. If x is nil,
// the fallback value is returned instead. Users are responsible for ensuring
// that T has no prohibitive copy or value semantics (for example, noCopy or
// implicit sharing due to shallow copying).
func From[T any](x *T, fallback T) T {
	if x == nil {
		return fallback
	}
	return *x
}