file

Documentation

Overview

Package file contains helpers to write auto-generated Go source files.

Index

• func Append(entity string, path string, snippet Snippet, iface bool) error
• func Reset(path string, imports []string, buildComment string, iface bool) error
• type Buffer
  • func (b *Buffer) L(format string, a ...any)
  • func (b *Buffer) N()
• type Snippet

Functions

func Append

func Append(entity string, path string, snippet Snippet, iface bool) error

Append a code snippet to a file.

func Reset

func Reset(path string, imports []string, buildComment string, iface bool) error

Reset an auto-generated source file, writing a new empty file header.

Types

type Buffer

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

Buffer for accumulating source code output.

func (*Buffer) L

func (b *Buffer) L(format string, a ...any)

L accumulates a single line of source code.

func (*Buffer) N

func (b *Buffer) N()

N accumulates a single new line.

type Snippet

type Snippet interface {
	Generate(buffer *Buffer) error
	GenerateSignature(buffer *Buffer) error
}

Snippet generates a single code snippet of a target source file code.