prefixer

Documentation

Index

• Constants
• type Prefixer
  • func NewPrefixer(input ast.Expr) Prefixer
  • func NewPrefixerEditor(prefixer Prefixer, editor editor) Prefixer

Constants

const Slice = "[]"

Slice represents the token for a go slice prefix.

const Star = "*"

Star represents the pointer prefix.

Types

type Prefixer

type Prefixer interface {
	// Valid validates the prefixer and its subprefixers.
	//
	// An example would be a composition of a StarExpr with an ArrayType of an Ident.
	// In that case, all three prefixers computed from those ast.Expr will be validated with Valid.
	Valid() error

	// ToString transforms a Prefixer (ast.Expr) into its string representation.
	// It also returns a boolean indicating whether the type is exported.
	ToString(sourcePackage string, typeParams []string, prefixes ...string) (stringType string, exported bool)
}

Prefixer represents an interface to transform a specific ast.Expr into its string representation.

func NewPrefixer

func NewPrefixer(input ast.Expr) Prefixer

NewPrefixer transforms the input expression into it's corresponding Prefixer interface.

It returns an error if the input expression hasn't a Prefixer implementation.

func NewPrefixerEditor

func NewPrefixerEditor(prefixer Prefixer, editor editor) Prefixer

NewPrefixerEditor creates a Prefixer wrapping another Prefixer.

It can be used to alter the result of the wrapped Prefixer to add like a name, edit the exported bool result or even remove, replace, or change the resulted string type.