verb

Documentation

Index

• Constants
• type Builder
  • func (b Builder) Build() FormatFn
  • func (b *Builder) Register(verb rune)
  • func (b *Builder) Reset()
  • func (b *Builder) SetPrefix(char rune)
• type FormatFn
• type Formatter

Constants

const (
	// DefaultPrefix is the default prefix for format strings.
	DefaultPrefix rune = '%'
)

Types

type Builder

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

Builder is a builder for format strings.

func (Builder) Build

func (b Builder) Build() FormatFn

Build builds a new format function.

Returns:

• FormatFn: The new format function. Never returns nil.

func (*Builder) Register

func (b *Builder) Register(verb rune)

Register registers a format verb. Does nothing if the receiver is nil.

Verbs that are the same as the prefix are ignored.

Parameters:

• verb: The format verb to register.

func (*Builder) Reset

func (b *Builder) Reset()

Reset resets the builder to make it reusable.

func (*Builder) SetPrefix

func (b *Builder) SetPrefix(char rune)

SetPrefix sets the prefix for specifying format verbs. Does nothing if the receiver is nil.

Parameters:

• char: The prefix to set.

type FormatFn

type FormatFn func(format string, data Formatter) (string, error)

FormatFn is the type for a format function.

Parameters:

• format: The format string.
• data: The data to format.

Returns:

• string: The formatted string.
• error: An error if the format could not be formatted.

type Formatter

type Formatter interface {
	// Format formats the data using the format string.
	//
	// Parameters:
	//   - format: The format string.
	//
	// Returns:
	//   - string: The formatted string.
	//   - error: An error if the format could not be formatted.
	Format(verb string) (string, error)
}

Formatter is the interface for a formatter.