codewriter

Documentation

Overview

Package codewriter is a simple helper for writing out source code.

Index

• type Writer
  • func New(pkg string) *Writer
  • func (c *Writer) Body() string
  • func (c *Writer) Bytes() []byte
  • func (c *Writer) Import(pkgs ...string)
  • func (c *Writer) In(fn func(w *Writer))
  • func (c *Writer) Indent()
  • func (c *Writer) L(format string, args ...any)
  • func (c *Writer) Pop() *Writer
  • func (c *Writer) Prelude() *Writer
  • func (c *Writer) Push() *Writer
  • func (c *Writer) String() string
  • func (c *Writer) Trailer() *Writer
  • func (c *Writer) W(format string, args ...any)

Types

type Writer

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

func New

func New(pkg string) *Writer

func (*Writer) Body

func (c *Writer) Body() string

Body returns the body of the code, without the package declaration and imports.

func (*Writer) Bytes

func (c *Writer) Bytes() []byte

Bytes returns the self-contained complete generated code.

func (*Writer) Import

func (c *Writer) Import(pkgs ...string)

Import adds an import to the generated code.

func (*Writer) In

func (c *Writer) In(fn func(w *Writer))

In calls "fn" with a Writer that is indented one level.

func (*Writer) Indent

func (c *Writer) Indent()

Indent writes the current indent level without a newline.

func (*Writer) L

func (c *Writer) L(format string, args ...any)

L writes a newline-terminated string to the writer.

func (*Writer) Pop

func (c *Writer) Pop() *Writer

Pop returns a Writer unindented one level.

func (*Writer) Prelude

func (c *Writer) Prelude() *Writer

func (*Writer) Push

func (c *Writer) Push() *Writer

Push returns a Writer indented one level.

func (*Writer) String

func (c *Writer) String() string

String returns the self-contained complete generated code.

func (*Writer) Trailer

func (c *Writer) Trailer() *Writer

Trailer returns a Writer that will be appended to the end of the code.

Useful for writing out helper functions and other globals.

func (*Writer) W

func (c *Writer) W(format string, args ...any)

W writes a formatted string directly to the writer without indentation or newline.