codegen

Documentation

Index

• func Prelude() *CommentGroup
• func Tag(tags map[string]string) *ast.BasicLit
• type FileSystemWriter
• type MemoryFileSystemWriter
  • func (w *MemoryFileSystemWriter) Get(name string) []byte
  • func (w *MemoryFileSystemWriter) OpenWriter(name string) (io.WriteCloser, error)
• type OSFileSystemWriter
  • func (w *OSFileSystemWriter) Create(name string) (io.WriteCloser, error)

Functions

func Prelude

func Prelude() *CommentGroup

Prelude creates a comment group indicating a generated file that shouldn't be edited.

func Tag

func Tag(tags map[string]string) *ast.BasicLit

TODO: Make this more robust (e.g., What about tags containing newlines?)

Types

type FileSystemWriter

type FileSystemWriter interface {
	Create(name string) (io.WriteCloser, error)
}

A FileSystemWriter provides the means to write files into a collection of named files.

type MemoryFileSystemWriter

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

MemoryFileSystemWriter allows writing into an in-memory map.

func (*MemoryFileSystemWriter) Get

func (w *MemoryFileSystemWriter) Get(name string) []byte

Get returns the bytes of the named file.

func (*MemoryFileSystemWriter) OpenWriter

func (w *MemoryFileSystemWriter) OpenWriter(name string) (io.WriteCloser, error)

OpenWriter opens an OS file for writing.

type OSFileSystemWriter

type OSFileSystemWriter struct {
	Root string
}

OSFileSystemWriter allows writing into the OS filesystem.

func (*OSFileSystemWriter) Create

func (w *OSFileSystemWriter) Create(name string) (io.WriteCloser, error)

OpenWriter opens an OS file for writing.