Enum Type

pub enum Type {
    Named(NamedType),
    NonNullNamed(NamedType),
    List(Box<Type>),
    NonNullList(Box<Type>),
}

Type system AST for a reference to a GraphQL Type

Variants

Named(NamedType)

A Foo reference to nullable named type

NonNullNamed(NamedType)

A Foo! reference to non-null named type

List(Box<Type>)

A […] reference to nullable list type. (The inner item type may or may not be nullable, or a nested list.)

NonNullList(Box<Type>)

A […]! reference to non-null list type. (The inner item type may or may not be nullable, or a nested list.)

Implementations

impl Type

pub fn non_null(self) -> Self

Returns this type made non-null, if it isn’t already.

pub fn nullable(self) -> Self

Returns this type made nullable, if it isn’t already.

pub fn list(self) -> Self

Returns a list type whose items are this type.

pub fn item_type(&self) -> &Self

If the type is a list type (nullable or not), returns the inner item type.

Otherwise returns self unchanged.

Example

use apollo_compiler::ty;
// Returns the inner type of the list.
assert_eq!(ty!([Foo!]).item_type(), &ty!(Foo!));
// Not a list: returns the input.
assert_eq!(ty!(Foo!).item_type(), &ty!(Foo!));

pub fn inner_named_type(&self) -> &NamedType

Returns the inner named type, after unwrapping any non-null or list markers.

pub fn is_non_null(&self) -> bool

Returns whether this type is non-null

pub fn is_list(&self) -> bool

Returns whether this type is a list type (nullable or not)

pub fn is_named(&self) -> bool

Returns whether this type is a named type (nullable or not), as opposed to a list type.

pub fn is_assignable_to(&self, target: &Self) -> bool

Can a value of this type be used when the target type is expected?

Implementation of spec function AreTypesCompatible().

pub fn parse( source_text: impl Into<String>, path: impl AsRef<Path>, ) -> Result<Self, DiagnosticList>

Parse the given source text as a reference to a type.

path is the filesystem path (or arbitrary string) used in diagnostics to identify this source file to users.

Create a Parser to use different parser configuration.

pub fn serialize(&self) -> Serialize<'_, Self>

Returns a builder that has chaining methods for setting serialization configuration, and implements the Display and ToString traits by writing GraphQL syntax.

Trait Implementations

impl Clone for Type

fn clone(&self) -> Type

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Type

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Type

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Type

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for Type

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Type

fn eq(&self, other: &Type) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Type

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Type

impl StructuralPartialEq for Type