file

Documentation

Overview

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

Index

• Constants
• func Append(path string, snippet Snippet) error
• func Reset(path string, imports []string) error
• type Buffer
  • func (b *Buffer) L(format string, a ...interface{})
  • func (b *Buffer) N()
• type Snippet

Constants

const BuildComment = `//go:build linux && cgo && !agent
// +build linux,cgo,!agent

`

BuildComment includes the necessary comments for building. The extra new line at the end is required.

Functions

func Append

func Append(path string, snippet Snippet) error

Append a code snippet to a file.

func Reset

func Reset(path string, imports []string) 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 ...interface{})

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.