favcliptools

Documentation

Index

• Variables
• type Plugger
• type Plugin
• type User
• type UserJSON
  • func (orig *UserJSON) Convert() (*User, error)
• type UserJSONBuilder
  • func NewUserJSONBuilder() *UserJSONBuilder
  • func (b *UserJSONBuilder) Add(info *UserPropertyInfo) *UserJSONBuilder
  • func (b *UserJSONBuilder) AddAll() *UserJSONBuilder
  • func (b *UserJSONBuilder) Convert(orig *User) (*UserJSON, error)
  • func (b *UserJSONBuilder) ConvertList(orig []*User) (UserJSONList, error)
  • func (b *UserJSONBuilder) Marshal(orig *User) ([]byte, error)
  • func (b *UserJSONBuilder) Remove(info *UserPropertyInfo) *UserJSONBuilder
• type UserJSONList
  • func (jsonList UserJSONList) Convert() ([]*User, error)
• type UserPropertyDecoder
• type UserPropertyEncoder
• type UserPropertyInfo
• type UserQueryBuilder
  • func NewUserQueryBuilder(client datastore.Client) *UserQueryBuilder
  • func NewUserQueryBuilderWithKind(client datastore.Client, kind string) *UserQueryBuilder
  • func (bldr *UserQueryBuilder) Ancestor(parentKey datastore.Key) *UserQueryBuilder
  • func (bldr *UserQueryBuilder) KeysOnly() *UserQueryBuilder
  • func (bldr *UserQueryBuilder) Limit(limit int) *UserQueryBuilder
  • func (bldr *UserQueryBuilder) Offset(offset int) *UserQueryBuilder
  • func (bldr *UserQueryBuilder) Query() datastore.Query
  • func (bldr *UserQueryBuilder) Start(cur datastore.Cursor) *UserQueryBuilder
• type UserQueryProperty
  • func (p *UserQueryProperty) Asc() *UserQueryBuilder
  • func (p *UserQueryProperty) Desc() *UserQueryBuilder
  • func (p *UserQueryProperty) Equal(value interface{}) *UserQueryBuilder
  • func (p *UserQueryProperty) Filter(op string, value interface{}) *UserQueryBuilder
  • func (p *UserQueryProperty) GreaterThan(value interface{}) *UserQueryBuilder
  • func (p *UserQueryProperty) GreaterThanOrEqual(value interface{}) *UserQueryBuilder
  • func (p *UserQueryProperty) LessThan(value interface{}) *UserQueryBuilder
  • func (p *UserQueryProperty) LessThanOrEqual(value interface{}) *UserQueryBuilder

Variables

var TestSuite = map[string]testsuite.Test{
	"FavclipTools": favclipTools,
}

TestSuite contains all the test cases that this package provides.

Types

type Plugger

type Plugger interface {
	Plugin() Plugin
}

Plugger supply Plugin component.

type Plugin

type Plugin interface {
	Init(typeName string)
	Ancestor(ancestor datastore.Key)
	KeysOnly()
	Start(cur datastore.Cursor)
	Offset(offset int)
	Limit(limit int)
	Filter(name, op string, value interface{})
	Asc(name string)
	Desc(name string)
}

Plugin supply hook point for query constructions.

type User

type User struct {
	ID       userID `datastore:"-" boom:"id" json:"id"`
	Name     string `json:"name"`
	MentorID userID `json:"mentorID"`
}

User kind +jwg +qbg

type UserJSON

type UserJSON struct {
	ID       userID `json:"id,omitempty"`
	Name     string `json:"name,omitempty"`
	MentorID userID `json:"mentorID,omitempty"`
}

UserJSON is jsonized struct for User.

func (*UserJSON) Convert

func (orig *UserJSON) Convert() (*User, error)

Convert specified JSON object to non-JSON object.

type UserJSONBuilder

type UserJSONBuilder struct {
	ID       *UserPropertyInfo
	Name     *UserPropertyInfo
	MentorID *UserPropertyInfo
	// contains filtered or unexported fields
}

UserJSONBuilder convert between User to UserJSON mutually.

func NewUserJSONBuilder

func NewUserJSONBuilder() *UserJSONBuilder

NewUserJSONBuilder make new UserJSONBuilder.

func (*UserJSONBuilder) Add

func (b *UserJSONBuilder) Add(info *UserPropertyInfo) *UserJSONBuilder

Add specified property to UserJSONBuilder.

func (*UserJSONBuilder) AddAll

func (b *UserJSONBuilder) AddAll() *UserJSONBuilder

AddAll adds all property to UserJSONBuilder.

func (*UserJSONBuilder) Convert

func (b *UserJSONBuilder) Convert(orig *User) (*UserJSON, error)

Convert specified non-JSON object to JSON object.

func (*UserJSONBuilder) ConvertList

func (b *UserJSONBuilder) ConvertList(orig []*User) (UserJSONList, error)

ConvertList specified non-JSON slice to JSONList.

func (*UserJSONBuilder) Marshal

func (b *UserJSONBuilder) Marshal(orig *User) ([]byte, error)

Marshal non-JSON object to JSON string.

func (*UserJSONBuilder) Remove

func (b *UserJSONBuilder) Remove(info *UserPropertyInfo) *UserJSONBuilder

Remove specified property to UserJSONBuilder.

type UserJSONList

type UserJSONList []*UserJSON

UserJSONList is synonym about []*UserJSON.

func (UserJSONList) Convert

func (jsonList UserJSONList) Convert() ([]*User, error)

Convert specified JSONList to non-JSON slice.

type UserPropertyDecoder

type UserPropertyDecoder func(src *UserJSON, dest *User) error

UserPropertyDecoder is property decoder for [1]sJSON.

type UserPropertyEncoder

type UserPropertyEncoder func(src *User, dest *UserJSON) error

UserPropertyEncoder is property encoder for [1]sJSON.

type UserPropertyInfo

type UserPropertyInfo struct {
	Encoder UserPropertyEncoder
	Decoder UserPropertyDecoder
	// contains filtered or unexported fields
}

UserPropertyInfo stores property information.

type UserQueryBuilder

type UserQueryBuilder struct {
	ID       *UserQueryProperty
	Name     *UserQueryProperty
	MentorID *UserQueryProperty
	// contains filtered or unexported fields
}

UserQueryBuilder build query for User.

func NewUserQueryBuilder

func NewUserQueryBuilder(client datastore.Client) *UserQueryBuilder

NewUserQueryBuilder create new UserQueryBuilder.

func NewUserQueryBuilderWithKind

func NewUserQueryBuilderWithKind(client datastore.Client, kind string) *UserQueryBuilder

NewUserQueryBuilderWithKind create new UserQueryBuilder with specific kind.

func (*UserQueryBuilder) Ancestor

func (bldr *UserQueryBuilder) Ancestor(parentKey datastore.Key) *UserQueryBuilder

Ancestor sets parent key to ancestor query.

func (*UserQueryBuilder) KeysOnly

func (bldr *UserQueryBuilder) KeysOnly() *UserQueryBuilder

KeysOnly sets keys only option to query.

func (*UserQueryBuilder) Limit

func (bldr *UserQueryBuilder) Limit(limit int) *UserQueryBuilder

Limit setup to query.

func (*UserQueryBuilder) Offset

func (bldr *UserQueryBuilder) Offset(offset int) *UserQueryBuilder

Offset setup to query.

func (*UserQueryBuilder) Query

func (bldr *UserQueryBuilder) Query() datastore.Query

Query returns *datastore.Query.

func (*UserQueryBuilder) Start

func (bldr *UserQueryBuilder) Start(cur datastore.Cursor) *UserQueryBuilder

Start setup to query.

type UserQueryProperty

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

UserQueryProperty has property information for UserQueryBuilder.

func (*UserQueryProperty) Asc

func (p *UserQueryProperty) Asc() *UserQueryBuilder

Asc order.

func (*UserQueryProperty) Desc

func (p *UserQueryProperty) Desc() *UserQueryBuilder

Desc order.

func (*UserQueryProperty) Equal

func (p *UserQueryProperty) Equal(value interface{}) *UserQueryBuilder

Equal filter with value.

func (*UserQueryProperty) Filter

func (p *UserQueryProperty) Filter(op string, value interface{}) *UserQueryBuilder

Filter with op & value.

func (*UserQueryProperty) GreaterThan

func (p *UserQueryProperty) GreaterThan(value interface{}) *UserQueryBuilder

GreaterThan filter with value.

func (*UserQueryProperty) GreaterThanOrEqual

func (p *UserQueryProperty) GreaterThanOrEqual(value interface{}) *UserQueryBuilder

GreaterThanOrEqual filter with value.

func (*UserQueryProperty) LessThan

func (p *UserQueryProperty) LessThan(value interface{}) *UserQueryBuilder

LessThan filter with value.

func (*UserQueryProperty) LessThanOrEqual

func (p *UserQueryProperty) LessThanOrEqual(value interface{}) *UserQueryBuilder

LessThanOrEqual filter with value.