attrs

README

attrs

Requirements

• Go 1.13+
• Go Modules

Installation

$ go get github.com/gobuffalo/attrs/cmd/attrs

---

Documentation

Index

• Constants
• Variables
• type Attr
  • func Parse(arg string) (Attr, error)
  • func (a Attr) CommonType() string
  • func (a Attr) GoType() string
  • func (a Attr) String() string
• type Attrs
  • func ParseArgs(args ...string) (Attrs, error)
  • func (ats Attrs) Slice() []string
• type NamedAttrs
  • func ParseNamedArgs(args ...string) (NamedAttrs, error)
  • func (n NamedAttrs) String() string
  • func (n NamedAttrs) Validate() error

Constants

const Version = "v0.1.0"

Version of attrs

Variables

var ErrMissingName = errors.New("requires a name argument")

var ErrRepeatedAttr = errors.New("duplicate attr name")

ErrRepeatedAttr is returned when parsing an array with repeated names

Types

type Attr

type Attr struct {
	Original string
	Name     name.Ident
	// contains filtered or unexported fields
}

Attr is buffalo's implementation for model attributes

func Parse

func Parse(arg string) (Attr, error)

Parse takes a string like name:commonType:goType and turns it into an Attr

func (Attr) CommonType

func (a Attr) CommonType() string

CommonType returns the common type of an attribute, this common type is used later for things like determining the database column type depending on the database.

func (Attr) GoType

func (a Attr) GoType() string

GoType returns the Go type for an Attr based on its commonType

func (Attr) String

func (a Attr) String() string

type Attrs

type Attrs []Attr

Attrs is a slice of Attr

func ParseArgs

func ParseArgs(args ...string) (Attrs, error)

ParseArgs parses passed string args into Attrs

func (Attrs) Slice

func (ats Attrs) Slice() []string

type NamedAttrs

type NamedAttrs struct {
	Name  name.Ident
	Attrs Attrs
}

func ParseNamedArgs

func ParseNamedArgs(args ...string) (NamedAttrs, error)

func (NamedAttrs) String

func (n NamedAttrs) String() string

func (NamedAttrs) Validate

func (n NamedAttrs) Validate() error