sangria.ast

package sangria.ast

Members list

Grouped members

scalar

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ScalarValue
trait Value
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
sealed trait ScalarValue extends Value

Attributes

Supertypes
trait Value
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
Known subtypes
class BigIntValue
class BooleanValue
class FloatValue
class IntValue
class StringValue
Show all
case class StringValue(value: String, block: Boolean, blockRawValue: Option[String], comments: Vector[Comment], location: Option[AstLocation]) extends ScalarValue

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait ScalarValue
trait Value
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all

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, WithDescription

Attributes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
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, WithTrailingComments, WithDescription

Attributes

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

Attributes

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

Attributes

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

Attributes

See also
Supertypes
trait Serializable
trait Product
trait Equals
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
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, WithTrailingComments, WithDescription

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all

Attributes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
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, WithTrailingComments, WithDescription

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
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, WithTrailingComments

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all

Attributes

Supertypes
trait Definition
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
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, WithTrailingComments, WithDescription

Attributes

See also
Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
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, WithTrailingComments

Attributes

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

Attributes

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

Attributes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
case class SchemaDefinition(operationTypes: Vector[OperationTypeDefinition], directives: Vector[Directive], description: Option[StringValue], comments: Vector[Comment], trailingComments: Vector[Comment], location: Option[AstLocation]) extends TypeSystemDefinition, WithDescription, WithTrailingComments, WithDirectives

A definition of a GraphQL schema.

A definition of a GraphQL schema.

Value parameters

operationTypes

The root operations available in this schema.

Attributes

See also
Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all

Attributes

Supertypes
trait Definition
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
Known subtypes

Attributes

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

Attributes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Definition
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all

value

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
object ObjectValue

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Value extends AstNode, 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
Supertypes
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Known subtypes
class EnumValue
class ListValue
class NullValue
class ObjectValue
trait ScalarValue
class BigIntValue
class BooleanValue
class FloatValue
class IntValue
class StringValue
Show all
case class VariableValue(name: String, comments: Vector[Comment], location: Option[AstLocation]) extends Value

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Value
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all

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.

Value parameters

delegates

The component documents.

id

Identifier for the combined document.

Attributes

Companion
object
Supertypes
trait SourceMapper
class Object
trait Matchable
class Any

Attributes

Companion
class
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

Supertypes
trait Serializable
trait Product
trait Equals
trait NameValue
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
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.

Value parameters

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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object AstLocation

Attributes

Companion
class
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

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

Attributes

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

Attributes

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

Supertypes
trait SourceMapper
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
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, WithArguments

Attributes

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

A complete GraphQL request operated on by a GraphQL service.

A complete GraphQL request operated on by a GraphQL service.

Value parameters

definitions

The definitions, which primarily constitute the document.

Attributes

See also
Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
Show all
object Document

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Document.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, SelectionContainer, WithArguments

Attributes

See also
Supertypes
trait Serializable
trait Product
trait Equals
trait Selection
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
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, ConditionalFragment, WithDirectives, SelectionContainer

Attributes

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

Attributes

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

Attributes

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

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
trait AstNode
class Object
trait Matchable
class Any
Show all
object InputDocument

Attributes

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

Attributes

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

Attributes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Type
trait AstNode
class Object
trait Matchable
class Any
Show all
sealed trait NameValue extends AstNode, WithComments

Attributes

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

Attributes

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

Attributes

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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait NameValue
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
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, WithDirectives, 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.

Value parameters

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.

Attributes

See also
Supertypes
trait Serializable
trait Product
trait Equals
trait WithComments
trait Definition
trait AstNode
class Object
trait Matchable
class Any
Show all
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
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Mutation
object Query
object Subscription
object OperationType

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed trait Selection extends AstNode, WithDirectives, 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
Supertypes
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
Known subtypes
class Field

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

Supertypes
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
Known subtypes
trait SourceMapper

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

Supertypes
class Object
trait Matchable
class Any
Known subtypes

Attributes

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

Attributes

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

A definition of a variable to an operation.

A definition of a variable to an operation.

Value parameters

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.

Attributes

See also
Supertypes
trait Serializable
trait Product
trait Equals
trait WithComments
trait AstNode
class Object
trait Matchable
class Any
Show all
sealed trait WithArguments extends AstNode

Attributes

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

Attributes

Supertypes
trait AstNode
class Object
trait Matchable
class Any
Known subtypes