graphql

Documentation

Index

• Variables
• func AddError(ctx context.Context, err error)
• func AddErrorf(ctx context.Context, format string, args ...interface{})
• func DefaultDirectiveMiddleware(ctx context.Context, next Resolver) (res interface{}, err error)
• func DefaultErrorPresenter(ctx context.Context, err error) *gqlerror.Error
• func DefaultRecover(ctx context.Context, err interface{}) error
• func DefaultRequestMiddleware(ctx context.Context, next func(ctx context.Context) []byte) []byte
• func DefaultResolverMiddleware(ctx context.Context, next Resolver) (res interface{}, err error)
• func OneShot(resp *Response) func() *Response
• func UnmarshalBoolean(v interface{}) (bool, error)
• func UnmarshalFloat(v interface{}) (float64, error)
• func UnmarshalID(v interface{}) (string, error)
• func UnmarshalInt(v interface{}) (int, error)
• func UnmarshalMap(v interface{}) (map[string]interface{}, error)
• func UnmarshalString(v interface{}) (string, error)
• func UnmarshalTime(v interface{}) (time.Time, error)
• func WithRequestContext(ctx context.Context, rc *RequestContext) context.Context
• func WithResolverContext(ctx context.Context, rc *ResolverContext) context.Context
• type Array
  • func (a Array) MarshalGQL(writer io.Writer)
• type CollectedField
  • func CollectFields(ctx context.Context, selSet ast.SelectionSet, satisfies []string) []CollectedField
  • func CollectFieldsCtx(ctx context.Context, satisfies []string) []CollectedField
• type ErrorPresenterFunc
• type ExecutableSchema
• type ExtendedError
• type FieldMiddleware
• type Marshaler
  • func Defer(f func() Marshaler) Marshaler
  • func MarshalBoolean(b bool) Marshaler
  • func MarshalFloat(f float64) Marshaler
  • func MarshalID(s string) Marshaler
  • func MarshalInt(i int) Marshaler
  • func MarshalMap(val map[string]interface{}) Marshaler
  • func MarshalString(s string) Marshaler
  • func MarshalTime(t time.Time) Marshaler
• type OrderedMap
  • func NewOrderedMap(len int) *OrderedMap
  • func (m *OrderedMap) Add(key string, value Marshaler)
  • func (m *OrderedMap) MarshalGQL(writer io.Writer)
• type RecoverFunc
• type RequestContext
  • func GetRequestContext(ctx context.Context) *RequestContext
  • func NewRequestContext(doc *ast.QueryDocument, query string, variables map[string]interface{}) *RequestContext
  • func (c *RequestContext) Error(ctx context.Context, err error)
  • func (c *RequestContext) Errorf(ctx context.Context, format string, args ...interface{})
• type RequestMiddleware
• type Resolver
• type ResolverContext
  • func GetResolverContext(ctx context.Context) *ResolverContext
  • func (r *ResolverContext) Pop()
  • func (r *ResolverContext) PushField(alias string)
  • func (r *ResolverContext) PushIndex(index int)
• type Response
  • func ErrorResponse(ctx context.Context, messagef string, args ...interface{}) *Response
• type Unmarshaler
• type WriterFunc
  • func (f WriterFunc) MarshalGQL(w io.Writer)

Variables

var False = lit(falseLit)

var Null = lit(nullLit)

var True = lit(trueLit)

Functions

func AddError

func AddError(ctx context.Context, err error)

AddError is a convenience method for adding an error to the current response

func AddErrorf

func AddErrorf(ctx context.Context, format string, args ...interface{})

AddErrorf is a convenience method for adding an error to the current response

func DefaultDirectiveMiddleware

func DefaultDirectiveMiddleware(ctx context.Context, next Resolver) (res interface{}, err error)

func DefaultErrorPresenter

func DefaultErrorPresenter(ctx context.Context, err error) *gqlerror.Error

func DefaultRecover

func DefaultRecover(ctx context.Context, err interface{}) error

func DefaultRequestMiddleware

func DefaultRequestMiddleware(ctx context.Context, next func(ctx context.Context) []byte) []byte

func DefaultResolverMiddleware

func DefaultResolverMiddleware(ctx context.Context, next Resolver) (res interface{}, err error)

func OneShot

func OneShot(resp *Response) func() *Response

func UnmarshalBoolean

func UnmarshalBoolean(v interface{}) (bool, error)

func UnmarshalFloat

func UnmarshalFloat(v interface{}) (float64, error)

func UnmarshalID

func UnmarshalID(v interface{}) (string, error)

func UnmarshalInt

func UnmarshalInt(v interface{}) (int, error)

func UnmarshalMap

func UnmarshalMap(v interface{}) (map[string]interface{}, error)

func UnmarshalString

func UnmarshalString(v interface{}) (string, error)

func UnmarshalTime

func UnmarshalTime(v interface{}) (time.Time, error)

func WithRequestContext

func WithRequestContext(ctx context.Context, rc *RequestContext) context.Context

func WithResolverContext

func WithResolverContext(ctx context.Context, rc *ResolverContext) context.Context

Types

type Array

type Array []Marshaler

func (Array) MarshalGQL

func (a Array) MarshalGQL(writer io.Writer)

type CollectedField

type CollectedField struct {
	*ast.Field

	Selections ast.SelectionSet
}

func CollectFields

func CollectFields(ctx context.Context, selSet ast.SelectionSet, satisfies []string) []CollectedField

func CollectFieldsCtx

func CollectFieldsCtx(ctx context.Context, satisfies []string) []CollectedField

This is just a convenient wrapper method for CollectFields

type ErrorPresenterFunc

type ErrorPresenterFunc func(context.Context, error) *gqlerror.Error

type ExecutableSchema

type ExecutableSchema interface {
	Schema() *ast.Schema

	Query(ctx context.Context, op *ast.OperationDefinition) *Response
	Mutation(ctx context.Context, op *ast.OperationDefinition) *Response
	Subscription(ctx context.Context, op *ast.OperationDefinition) func() *Response
}

type ExtendedError

type ExtendedError interface {
	Extensions() map[string]interface{}
}

type FieldMiddleware

type FieldMiddleware func(ctx context.Context, next Resolver) (res interface{}, err error)

type Marshaler

type Marshaler interface {
	MarshalGQL(w io.Writer)
}

func Defer

func Defer(f func() Marshaler) Marshaler

Defer will begin executing the given function and immediately return a result that will block until the function completes

func MarshalBoolean

func MarshalBoolean(b bool) Marshaler

func MarshalFloat

func MarshalFloat(f float64) Marshaler

func MarshalID

func MarshalID(s string) Marshaler

func MarshalInt

func MarshalInt(i int) Marshaler

func MarshalMap

func MarshalMap(val map[string]interface{}) Marshaler

func MarshalString

func MarshalString(s string) Marshaler

func MarshalTime

func MarshalTime(t time.Time) Marshaler

type OrderedMap

type OrderedMap struct {
	Keys   []string
	Values []Marshaler
}

func NewOrderedMap

func NewOrderedMap(len int) *OrderedMap

func (*OrderedMap) Add

func (m *OrderedMap) Add(key string, value Marshaler)

func (*OrderedMap) MarshalGQL

func (m *OrderedMap) MarshalGQL(writer io.Writer)

type RecoverFunc

type RecoverFunc func(ctx context.Context, err interface{}) (userMessage error)

type RequestContext

type RequestContext struct {
	RawQuery  string
	Variables map[string]interface{}
	Doc       *ast.QueryDocument
	// ErrorPresenter will be used to generate the error
	// message from errors given to Error().
	ErrorPresenter      ErrorPresenterFunc
	Recover             RecoverFunc
	ResolverMiddleware  FieldMiddleware
	DirectiveMiddleware FieldMiddleware
	RequestMiddleware   RequestMiddleware

	Errors gqlerror.List
	// contains filtered or unexported fields
}

func GetRequestContext

func GetRequestContext(ctx context.Context) *RequestContext

func NewRequestContext

func NewRequestContext(doc *ast.QueryDocument, query string, variables map[string]interface{}) *RequestContext

func (*RequestContext) Error

func (c *RequestContext) Error(ctx context.Context, err error)

Error sends an error to the client, passing it through the formatter.

func (*RequestContext) Errorf

func (c *RequestContext) Errorf(ctx context.Context, format string, args ...interface{})

Errorf sends an error string to the client, passing it through the formatter.

type RequestMiddleware

type RequestMiddleware func(ctx context.Context, next func(ctx context.Context) []byte) []byte

type Resolver

type Resolver func(ctx context.Context) (res interface{}, err error)

type ResolverContext

type ResolverContext struct {
	// The name of the type this field belongs to
	Object string
	// These are the args after processing, they can be mutated in middleware to change what the resolver will get.
	Args map[string]interface{}
	// The raw field
	Field CollectedField
	// The path of fields to get to this resolver
	Path []interface{}
}

func GetResolverContext

func GetResolverContext(ctx context.Context) *ResolverContext

func (*ResolverContext) Pop

func (r *ResolverContext) Pop()

func (*ResolverContext) PushField

func (r *ResolverContext) PushField(alias string)

func (*ResolverContext) PushIndex

func (r *ResolverContext) PushIndex(index int)

type Response

type Response struct {
	Data   json.RawMessage `json:"data"`
	Errors gqlerror.List   `json:"errors,omitempty"`
}

func ErrorResponse

func ErrorResponse(ctx context.Context, messagef string, args ...interface{}) *Response

type Unmarshaler

type Unmarshaler interface {
	UnmarshalGQL(v interface{}) error
}

type WriterFunc

type WriterFunc func(writer io.Writer)

func (WriterFunc) MarshalGQL

func (f WriterFunc) MarshalGQL(w io.Writer)