pointer

Documentation

Overview

pointer is a pointer to a value of type T.

Example (SimpleNewAndUse)

package main

import (
	"fmt"

	"github.com/snowmerak/generics-for-go/v2/types/pointer"
)

func main() {
	i := 10
	a := pointer.New(&i)
	*a.Load() = 20
	fmt.Println(i)
}

Output:

20

Example (SwapPointer)

package main

import (
	"fmt"

	"github.com/snowmerak/generics-for-go/v2/types/pointer"
)

func main() {
	i := 10
	a := pointer.New(&i)
	n := 20
	a.CompareAndSwap(&n, &i)
	fmt.Println(*a.Load())
}

Output:

20

Index

• type Pointer
  • func New[T any](pointer *T) Pointer[T]
  • func (p *Pointer[T]) Clone() Pointer[T]
  • func (p *Pointer[T]) CompareAndSwap(old *T, new *T) bool
  • func (p *Pointer[T]) IsNil() bool
  • func (p *Pointer[T]) Load() *T
  • func (p *Pointer[T]) Run(f func(*T)) bool
  • func (p *Pointer[T]) Store(pointer *T)
  • func (p *Pointer[T]) Swap(new *T) *T

Examples

• Package (SimpleNewAndUse)
• Package (SwapPointer)

Types

type Pointer

type Pointer[T any] struct {
	// contains filtered or unexported fields
}

Pointer is a container of T pointer.

func New

func New[T any](pointer *T) Pointer[T]

New returns a new Pointer.

func (*Pointer[T]) Clone

func (p *Pointer[T]) Clone() Pointer[T]

Clone returns a new Pointer with the same value as the old one.

func (*Pointer[T]) CompareAndSwap

func (p *Pointer[T]) CompareAndSwap(old *T, new *T) bool

CompareAndSwap sets the value of the Pointer if the current value is equal to the expected value.

func (*Pointer[T]) IsNil

func (p *Pointer[T]) IsNil() bool

IsNil returns true if the Pointer is nil.

func (*Pointer[T]) Load

func (p *Pointer[T]) Load() *T

Load returns the value of the Pointer.

func (*Pointer[T]) Run

func (p *Pointer[T]) Run(f func(*T)) bool

Run is a function that takes a pointer of type T. if pointer is nil, returns false.

func (*Pointer[T]) Store

func (p *Pointer[T]) Store(pointer *T)

Store sets the value of the Pointer.

func (*Pointer[T]) Swap

func (p *Pointer[T]) Swap(new *T) *T

Swap sets the value of the Pointer and returns the previous value.