resources

Documentation

Index

• type AuthToken
• type AuthTokenAttributes
• type AuthTokenListResponse
• type AuthTokenResponse
• type Details
  • func (d Details) MarshalJSON() ([]byte, error)
  • func (r *Details) Scan(src interface{}) error
  • func (d Details) String() string
  • func (d *Details) UnmarshalJSON(data []byte) error
  • func (r Details) Value() (driver.Value, error)
• type Flag
• type Flagger
• type Flags
  • func FlagsFromMask(mask int32, allFlags map[int32]string) Flags
• type Included
  • func (c *Included) Add(includes ...Resource)
  • func (c Included) MarshalJSON() ([]byte, error)
  • func (c *Included) MustAuthToken(key Key) *AuthToken
  • func (c *Included) MustLogin(key Key) *Login
  • func (c *Included) MustRefresh(key Key) *Refresh
  • func (c *Included) UnmarshalJSON(data []byte) error
• type Key
  • func NewKeyInt64(id int64, resourceType ResourceType) Key
  • func (r Key) AsRelation() *Relation
  • func (r *Key) GetKey() Key
  • func (r Key) GetKeyP() *Key
• type Links
• type Login
• type LoginAttributes
• type LoginListResponse
• type LoginResponse
• type Refresh
• type RefreshAttributes
• type RefreshListResponse
• type RefreshResponse
• type Relation
• type RelationCollection
  • func (r RelationCollection) MarshalJSON() ([]byte, error)
• type Resource
• type ResourceType

Types

type AuthToken

type AuthToken struct {
	Key
	Attributes AuthTokenAttributes `json:"attributes"`
}

type AuthTokenAttributes

type AuthTokenAttributes struct {
	Access string `json:"access"`
}

type AuthTokenListResponse

type AuthTokenListResponse struct {
	Data     []AuthToken `json:"data"`
	Included Included    `json:"included"`
	Links    *Links      `json:"links"`
}

type AuthTokenResponse

type AuthTokenResponse struct {
	Data     AuthToken `json:"data"`
	Included Included  `json:"included"`
}

type Details

type Details json.RawMessage

func (Details) MarshalJSON

func (d Details) MarshalJSON() ([]byte, error)

MarshalJSON - casts Details to []byte

func (*Details) Scan

func (r *Details) Scan(src interface{}) error

Scan - implements db driver method for auto unmarshal

func (Details) String

func (d Details) String() string

func (*Details) UnmarshalJSON

func (d *Details) UnmarshalJSON(data []byte) error

UnmarshalJSON - casts data to Details

func (Details) Value

func (r Details) Value() (driver.Value, error)

Value - implements db driver method for auto marshal

type Flag

type Flag struct {
	Name  string `json:"name"`
	Value int32  `json:"value"`
}

type Flagger

type Flagger interface {
	IsFlag() bool
}

type Flags

type Flags struct {
	Mask   int32  `json:"mask"`
	Values []Flag `json:"flags"`
}

func FlagsFromMask

func FlagsFromMask(mask int32, allFlags map[int32]string) Flags

type Included

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

Included - an array of Resource objects that are related to the primary data and/or each other (“included resources”).

func (*Included) Add

func (c *Included) Add(includes ...Resource)

Add - adds new include into collection. If one already present - skips it

func (Included) MarshalJSON

func (c Included) MarshalJSON() ([]byte, error)

MarshalJSON - marshals include collection as array of json objects

func (*Included) MustAuthToken

func (c *Included) MustAuthToken(key Key) *AuthToken

MustAuthToken - returns AuthToken from include collection. if entry with specified key does not exist - returns nil if entry with specified key exists but type or ID mismatches - panics

func (*Included) MustLogin

func (c *Included) MustLogin(key Key) *Login

MustLogin - returns Login from include collection. if entry with specified key does not exist - returns nil if entry with specified key exists but type or ID mismatches - panics

func (*Included) MustRefresh

func (c *Included) MustRefresh(key Key) *Refresh

MustRefresh - returns Refresh from include collection. if entry with specified key does not exist - returns nil if entry with specified key exists but type or ID mismatches - panics

func (*Included) UnmarshalJSON

func (c *Included) UnmarshalJSON(data []byte) error

UmarshalJSON - unmarshal array of json objects into include collection

type Key

type Key struct {
	ID   string       `json:"id"`
	Type ResourceType `json:"type"`
}

func NewKeyInt64

func NewKeyInt64(id int64, resourceType ResourceType) Key

func (Key) AsRelation

func (r Key) AsRelation() *Relation

func (*Key) GetKey

func (r *Key) GetKey() Key

func (Key) GetKeyP

func (r Key) GetKeyP() *Key

type Links

type Links struct {
	First string `json:"first"`
	Last  string `json:"last"`
	Next  string `json:"next"`
	Prev  string `json:"prev"`
	Self  string `json:"self"`
}

type Login

type Login struct {
	Key
	Attributes LoginAttributes `json:"attributes"`
}

type LoginAttributes

type LoginAttributes struct {
	Email    string `json:"email"`
	Password string `json:"password"`
}

type LoginListResponse

type LoginListResponse struct {
	Data     []Login  `json:"data"`
	Included Included `json:"included"`
	Links    *Links   `json:"links"`
}

type LoginResponse

type LoginResponse struct {
	Data     Login    `json:"data"`
	Included Included `json:"included"`
}

type Refresh

type Refresh struct {
	Key
	Attributes RefreshAttributes `json:"attributes"`
}

type RefreshAttributes

type RefreshAttributes struct {
	Token string `json:"token"`
}

type RefreshListResponse

type RefreshListResponse struct {
	Data     []Refresh `json:"data"`
	Included Included  `json:"included"`
	Links    *Links    `json:"links"`
}

type RefreshResponse

type RefreshResponse struct {
	Data     Refresh  `json:"data"`
	Included Included `json:"included"`
}

type Relation

type Relation struct {
	Data  *Key   `json:"data,omitempty"`
	Links *Links `json:"links,omitempty"`
}

type RelationCollection

type RelationCollection struct {
	Data  []Key  `json:"data"`
	Links *Links `json:"links,omitempty"`
}

func (RelationCollection) MarshalJSON

func (r RelationCollection) MarshalJSON() ([]byte, error)

type Resource

type Resource interface {
	//GetKey - returns key of the Resource
	GetKey() Key
}

type ResourceType

type ResourceType string

const (
	AUTH_TOKEN ResourceType = "auth_token"
	LOGIN      ResourceType = "login"
	REFRESH    ResourceType = "refresh"
)

List of ResourceType