immutable

Documentation

Overview

Package immutable provides code generator to generate immmutable-like objects and builders for them

Index

• Variables
• type Generator
  • func FromFile(filename string) *Generator
  • func (g *Generator) Generate(w io.Writer) error
  • func (g *Generator) WithPackageName(name string) *Generator

Variables

var (
	// ErrBadInputType indicates that given type can not be used to generate immutable structure
	ErrBadInputType = errors.New("Input type must be go interface")

	// ErrUnsupportedMethodSignature indicates that method is not suitble to generate immutable structure
	ErrUnsupportedMethodSignature = errors.New("Method must not be anonymous, have 0 input parameters and 1 output")
)

Types

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator implements immutables code generator

func FromFile

func FromFile(filename string) *Generator

FromFile returns ImmutableGenerator from given file

func (*Generator) Generate

func (g *Generator) Generate(w io.Writer) error

Generate generates immutable struct and builder from a given interface

func (*Generator) WithPackageName

func (g *Generator) WithPackageName(name string) *Generator

WithPackageName sets the package name