vcgen

Documentation

Index

• Variables
• type Generator
  • func Default() *Generator
  • func New(i *Generator) *Generator
  • func NewWithOptions(opts ...Option) (*Generator, error)
  • func (g *Generator) Run() ([]string, error)
• type Option
  • func SetCharset(charset string) Option
  • func SetCount(count uint16) Option
  • func SetLength(length uint16) Option
  • func SetPattern(pattern string) Option
  • func SetPrefix(prefix string) Option
  • func SetSuffix(suffix string) Option

Variables

var (
	ErrNotFeasible       = errors.New("Not feasible to generate requested number of codes")
	ErrPatternIsNotMatch = errors.New("Pattern is not match with the length value")
)

var (
	ErrInvalidCount   = errors.New("invalid count, It should be greater than 0")
	ErrInvalidCharset = errors.New("invalid charset, charset length should be greater than 0")
	ErrInvalidPattern = errors.New("invalid pattern, pattern cannot be empty")
)

Types

type Generator

type Generator struct {
	// Length of the code
	Length uint16 `json:"length"`

	// Count of the codes
	Count uint16 `json:"count"`

	// Charset to use
	Charset string `json:"charset"`

	// Prefix of the code
	Prefix string `json:"prefix"`

	// Suffix of the code
	Suffix string `json:"suffix"`

	// Pattern of the code
	Pattern string `json:"pattern"`

	// Suffix of the code
	//
	// Deprecated: use Suffix instead
	Postfix string `json:"postfix"`
}

func Default

func Default() *Generator

Creates a new generator with default values

func New

func New(i *Generator) *Generator

New generator config

Deprecated: use NewWithOptions or Default instead

func NewWithOptions

func NewWithOptions(opts ...Option) (*Generator, error)

Creates a new generator with options

func (*Generator) Run

func (g *Generator) Run() ([]string, error)

Generates a list of codes

type Option

type Option func(*Generator) error

func SetCharset

func SetCharset(charset string) Option

SetCharset sets the charset of the code

func SetCount

func SetCount(count uint16) Option

SetCount sets the count of the code

func SetLength

func SetLength(length uint16) Option

SetLength sets the length of the code

func SetPattern

func SetPattern(pattern string) Option

SetPattern sets the pattern of the code

func SetPrefix

func SetPrefix(prefix string) Option

SetPrefix sets the prefix of the code

func SetSuffix

func SetSuffix(suffix string) Option

SetSuffix sets the suffix of the code