sangria.ast

package sangria.ast

Members list

Concise view

scalar

case class BigDecimalValue(value: BigDecimal, comments: Vector[Comment], location: Option[AstLocation]) extends ScalarValue

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait AstNode
class Object
trait Matchable
class Any
case class BigIntValue(value: BigInt, comments: Vector[Comment], location: Option[AstLocation]) extends ScalarValue

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait AstNode
class Object
trait Matchable
class Any
case class BooleanValue(value: Boolean, comments: Vector[Comment], location: Option[AstLocation]) extends ScalarValue

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait AstNode
class Object
trait Matchable
class Any
case class FloatValue(value: Double, comments: Vector[Comment], location: Option[AstLocation]) extends ScalarValue

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait AstNode
class Object
trait Matchable
class Any
case class IntValue(value: Int, comments: Vector[Comment], location: Option[AstLocation]) extends ScalarValue

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait AstNode
class Object
trait Matchable
class Any
sealed trait ScalarValue extends Value

Attributes

Graph
Supertypes
trait Value
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
case class StringValue(value: String, block: Boolean, blockRawValue: Option[String], comments: Vector[Comment], location: Option[AstLocation]) extends ScalarValue

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait AstNode
class Object
trait Matchable
class Any

typesystem

case class DirectiveDefinition(name: String, arguments: Vector[InputValueDefinition], locations: Vector[DirectiveLocation], description: Option[StringValue], repeatable: Boolean, comments: Vector[Comment], location: Option[AstLocation]) extends TypeSystemDefinition with WithDescription

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class DirectiveLocation(name: String, comments: Vector[Comment], location: Option[AstLocation]) extends SchemaAstNode

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class EnumTypeDefinition(name: String, values: Vector[EnumValueDefinition], directives: Vector[Directive], description: Option[StringValue], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends TypeDefinition with WithTrailingComments with WithDescription

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class EnumTypeExtensionDefinition(name: String, values: Vector[EnumValueDefinition], directives: Vector[Directive], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends TypeExtensionDefinition with WithTrailingComments

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class EnumValueDefinition(name: String, directives: Vector[Directive], description: Option[StringValue], comments: Vector[Comment], location: Option[AstLocation]) extends SchemaAstNode with WithDirectives with WithDescription

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class FieldDefinition(name: String, fieldType: Type, arguments: Vector[InputValueDefinition], directives: Vector[Directive], description: Option[StringValue], comments: Vector[Comment], location: Option[AstLocation]) extends SchemaAstNode with WithDirectives with WithDescription

Attributes

See also:
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class InputObjectTypeDefinition(name: String, fields: Vector[InputValueDefinition], directives: Vector[Directive], description: Option[StringValue], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends TypeDefinition with WithTrailingComments with WithDescription

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class InputObjectTypeExtensionDefinition(name: String, fields: Vector[InputValueDefinition], directives: Vector[Directive], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends TypeExtensionDefinition with WithTrailingComments

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class InputValueDefinition(name: String, valueType: Type, defaultValue: Option[Value], directives: Vector[Directive], description: Option[StringValue], comments: Vector[Comment], location: Option[AstLocation]) extends SchemaAstNode with WithDirectives with WithDescription

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class InterfaceTypeDefinition(name: String, fields: Vector[FieldDefinition], interfaces: Vector[NamedType], directives: Vector[Directive], description: Option[StringValue], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends TypeDefinition with WithTrailingComments with WithDescription

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class InterfaceTypeExtensionDefinition(name: String, interfaces: Vector[NamedType], fields: Vector[FieldDefinition], directives: Vector[Directive], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends ObjectLikeTypeExtensionDefinition with WithTrailingComments

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
case class ObjectTypeDefinition(name: String, interfaces: Vector[NamedType], fields: Vector[FieldDefinition], directives: Vector[Directive], description: Option[StringValue], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends TypeDefinition with WithTrailingComments with WithDescription

Attributes

See also:
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class ObjectTypeExtensionDefinition(name: String, interfaces: Vector[NamedType], fields: Vector[FieldDefinition], directives: Vector[Directive], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends ObjectLikeTypeExtensionDefinition with WithTrailingComments

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class OperationTypeDefinition(operation: OperationType, tpe: NamedType, comments: Vector[Comment], location: Option[AstLocation]) extends SchemaAstNode

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class ScalarTypeDefinition(name: String, directives: Vector[Directive], description: Option[StringValue], comments: Vector[Comment], location: Option[AstLocation]) extends TypeDefinition with WithDescription

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class ScalarTypeExtensionDefinition(name: String, directives: Vector[Directive], comments: Vector[Comment], location: Option[AstLocation]) extends TypeExtensionDefinition

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
sealed trait SchemaAstNode extends AstNode with WithComments

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
case class SchemaDefinition(operationTypes: Vector[OperationTypeDefinition], directives: Vector[Directive], description: Option[StringValue], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends TypeSystemDefinition with WithDescription with WithTrailingComments with WithDirectives

A definition of a GraphQL schema.

A definition of a GraphQL schema.

Attributes

operationTypes

The root operations available in this schema.

See also:
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class SchemaExtensionDefinition(operationTypes: Vector[OperationTypeDefinition], directives: Vector[Directive], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends TypeSystemExtensionDefinition with WithDirectives with WithTrailingComments

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
case class UnionTypeDefinition(name: String, types: Vector[NamedType], directives: Vector[Directive], description: Option[StringValue], comments: Vector[Comment], location: Option[AstLocation]) extends TypeDefinition with WithDescription

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class UnionTypeExtensionDefinition(name: String, types: Vector[NamedType], directives: Vector[Directive], comments: Vector[Comment], location: Option[AstLocation]) extends TypeExtensionDefinition

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any

value

case class EnumValue(value: String, comments: Vector[Comment], location: Option[AstLocation]) extends Value

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait AstNode
class Object
trait Matchable
class Any
case class ListValue(values: Vector[Value], comments: Vector[Comment], location: Option[AstLocation]) extends Value

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait AstNode
class Object
trait Matchable
class Any
case class NullValue(comments: Vector[Comment], location: Option[AstLocation]) extends Value

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait AstNode
class Object
trait Matchable
class Any
case class ObjectValue(fields: Vector[ObjectField], comments: Vector[Comment], location: Option[AstLocation]) extends Value

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait AstNode
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Value extends AstNode with WithComments

A value that can be substituted into a GraphQL operation variable.

A value that can be substituted into a GraphQL operation variable.

Called "input values" in the GraphQL spec. Input values can be scalars, enumeration values, lists, objects, or null values.

Attributes

See also:
Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
case class VariableValue(name: String, comments: Vector[Comment], location: Option[AstLocation]) extends Value

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait AstNode
class Object
trait Matchable
class Any

Type members

Classlikes

class AggregateSourceMapper(val id: String, val delegates: Vector[SourceMapper]) extends SourceMapper

SourceMapper for potentially multiple GraphQL documents.

SourceMapper for potentially multiple GraphQL documents.

Sometimes it's necessary to compose a GraphQL document from multiple component documents; this class provides the corresponding SourceMapper to support that.

Attributes

delegates

The component documents.

id

Identifier for the combined document.

Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
case class Argument(name: String, value: Value, comments: Vector[Comment], location: Option[AstLocation]) extends NameValue

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait NameValue
trait AstNode
class Object
trait Matchable
class Any
case class AstLocation(sourceId: String, index: Int, line: Int, column: Int)

A location within a GraphQL source code string.

A location within a GraphQL source code string.

Attributes

column

The column number of the location within the source code.

index

The offset of the location as characters from the start of the source code.

line

The line number of the location within the source code.

sourceId

The ID of the source code.

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait AstNode

A node in the AST of a parsed GraphQL request document.

A node in the AST of a parsed GraphQL request document.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
case class Comment(text: String, location: Option[AstLocation]) extends AstNode

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
sealed trait ConditionalFragment extends AstNode

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
class DefaultSourceMapper(val id: String, val sourceMapperInput: SourceMapperInput) extends SourceMapper

sangria.ast.SourceMapper for a single GraphQL document.

sangria.ast.SourceMapper for a single GraphQL document.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
sealed trait Definition extends AstNode

A definition in a GraphQL document.

A definition in a GraphQL document.

A GraphQL document consists primarily of definitions, which are either executable or representative of a GraphQL type system. The executable definitions are operation and fragment definitions; those that represent a type system fall into definition or extension categories.

Attributes

See also:
Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
case class Directive(name: String, arguments: Vector[Argument], comments: Vector[Comment], location: Option[AstLocation]) extends AstNode with WithArguments

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class Document(definitions: Vector[Definition], trailingComments: Vector[Comment], location: Option[AstLocation], sourceMapper: Option[SourceMapper]) extends AstNode with WithTrailingComments

A complete GraphQL request operated on by a GraphQL service.

A complete GraphQL request operated on by a GraphQL service.

Attributes

definitions

The definitions, which primarily constitute the document.

See also:
Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
object Document

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Field(alias: Option[String], name: String, arguments: Vector[Argument], directives: Vector[Directive], selections: Vector[Selection], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends Selection with SelectionContainer with WithArguments

Attributes

See also:
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Selection
trait AstNode
class Object
trait Matchable
class Any
case class FragmentDefinition(name: String, typeCondition: NamedType, directives: Vector[Directive], selections: Vector[Selection], variables: Vector[VariableDefinition], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends Definition with ConditionalFragment with WithDirectives with SelectionContainer

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
case class FragmentSpread(name: String, directives: Vector[Directive], comments: Vector[Comment], location: Option[AstLocation]) extends Selection

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Selection
trait AstNode
class Object
trait Matchable
class Any
case class InlineFragment(typeCondition: Option[NamedType], directives: Vector[Directive], selections: Vector[Selection], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends Selection with ConditionalFragment with SelectionContainer

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Selection
trait AstNode
class Object
trait Matchable
class Any
case class InputDocument(values: Vector[Value], trailingComments: Vector[Comment], location: Option[AstLocation], sourceMapper: Option[SourceMapper]) extends AstNode with WithTrailingComments

Attributes

Companion:
object
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type

Attributes

Companion:
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ListType(ofType: Type, location: Option[AstLocation]) extends Type

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Type
trait AstNode
class Object
trait Matchable
class Any
sealed trait NameValue extends AstNode with WithComments

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
case class NamedType(name: String, location: Option[AstLocation]) extends Type

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Type
trait AstNode
class Object
trait Matchable
class Any
case class NotNullType(ofType: Type, location: Option[AstLocation]) extends Type

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait Type
trait AstNode
class Object
trait Matchable
class Any
case class ObjectField(name: String, value: Value, comments: Vector[Comment], location: Option[AstLocation]) extends NameValue

Attributes

Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait NameValue
trait AstNode
class Object
trait Matchable
class Any
case class OperationDefinition(operationType: OperationType, name: Option[String], variables: Vector[VariableDefinition], directives: Vector[Directive], selections: Vector[Selection], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends Definition with WithDirectives with SelectionContainer

A definition of a GraphQL operation.

A definition of a GraphQL operation.

Every GraphQL request invokes a specific operation, possibly with values to substitute into the operation's variables.

Attributes

name

The name of the operation. Optional only if there is only one operation in the document. Used for selecting the specific operation to invoke in a GraphQL request.

variables

The variables that must be substituted into the operation. Values for these must be provided either by their defaults or with the GraphQL request.

See also:
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
sealed trait OperationType

A type of operation in a GraphQL model.

A type of operation in a GraphQL model.

Every GraphQL operation is either a query, mutation or subscription.

Attributes

See also:
Companion:
object
Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Mutation.type
object Query.type
object Subscription.type

Attributes

Companion:
trait
Graph
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Selection extends AstNode with WithDirectives with WithComments

A component of information to be queried and returned.

A component of information to be queried and returned.

Most typically a selection is a field.

Attributes

See also:
Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes

A GraphQL AST node that contains selections.

A GraphQL AST node that contains selections.

Most typically, this is a field that is of a composite type.

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes

Set of functions that convert a GraphQL source code location to human-readable strings.

Set of functions that convert a GraphQL source code location to human-readable strings.

When rendering the results of a GraphQL document parse, it's helpful to describe where parsing failed. This is the interface to that facility.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
sealed trait Type extends AstNode

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
case class VariableDefinition(name: String, tpe: Type, defaultValue: Option[Value], directives: Vector[Directive], comments: Vector[Comment], location: Option[AstLocation]) extends AstNode with WithComments with WithDirectives

A definition of a variable to an operation.

A definition of a variable to an operation.

Attributes

defaultValue

Value that the variable should assume in an operation if none was provided with the GraphQL request.

name

Name of the variable being defined.

See also:
Graph
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
sealed trait WithArguments extends AstNode

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
class Directive
class Field
sealed trait WithComments extends AstNode

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
sealed trait WithDescription extends AstNode

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
sealed trait WithDirectives extends AstNode

Attributes

Graph
Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Known subtypes