immutable

README

myitcv.io/immutable

go get -u myitcv.io/immutable

Package immutable is a helper package for the immutable data structures generated by immutableGen.

See the immutableGen wiki for more details.

Contributors

• @aprotopapas
• @subash-a

Documentation

Overview

Package immutable is a helper package for the immutable data structures generated by myitcv.io/immutable/cmd/immutableGen.

Index

• Constants
• type Immutable

Constants

const (
	CmdImmutableGen = "immutableGen"
	CmdImmutableVet = "immutableVet"
)

const (
	// ImmTypeTmplPrefix is the prefix used to identify immutable type templates
	ImmTypeTmplPrefix = "_Imm_"

	// Pkg is the import path of this package
	PkgImportPath = "myitcv.io/immutable"
)

Types

type Immutable

type Immutable interface {
	Mutable() bool
	IsDeeplyNonMutable(seen map[interface{}]bool) bool
}

Immutable is the interface implemented by all immutable types. If Go had generics the interface would be defined, assuming a generic type parameter T, as follows:

type Immutable<T> interface {
	AsMutable() T
	AsImmutable() T
	WithMutations(f func(v T)) T
	Mutable() bool
}

Because we do not have such a type parameter we can only define the Mutable() method in the interface