Struct async_graphql::dynamic::Scalar

pub struct Scalar { /* private fields */ }

Available on crate feature dynamic-schema only.

A GraphQL scalar type

Examples

use async_graphql::{dynamic::*, value, Value};

let my_scalar = Scalar::new("MyScalar");

let query = Object::new("Query").field(Field::new("value", TypeRef::named_nn(my_scalar.type_name()), |ctx| {
    FieldFuture::new(async move { Ok(Some(Value::from("abc"))) })
}));


let schema = Schema::build(query.type_name(), None, None)
    .register(my_scalar)
    .register(query)
    .finish()?;

assert_eq!(
   schema
       .execute("{ value }")
       .await
       .into_result()
       .unwrap()
       .data,
   value!({ "value": "abc" })
);

Implementations

impl Scalar

pub fn new(name: impl Into<String>) -> Self

Create a GraphQL scalar type

pub fn description(self, description: impl Into<String>) -> Self

Set the description

pub fn inaccessible(self) -> Self

Indicate that an enum is not accessible from a supergraph when using Apollo Federation

Reference: https://www.apollographql.com/docs/federation/federated-types/federated-directives/#inaccessible

pub fn tags<I: IntoIterator<Item = T>, T: Into<String>>(self, tags: I) -> Self

Arbitrary string metadata that will be propagated to the supergraph when using Apollo Federation. This attribute is repeatable

Reference: https://www.apollographql.com/docs/federation/federated-types/federated-directives/#applying-metadata

pub fn validator( self, validator: impl Fn(&Value) -> bool + Send + Sync + 'static ) -> Self

Set the validator

pub fn specified_by_url(self, specified_by_url: impl Into<String>) -> Self

Set the specified by url

pub fn type_name(&self) -> &str

Returns the type name

Trait Implementations

impl Debug for Scalar

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

Formats the value using the given formatter.

impl From<Scalar> for Type

fn from(scalar: Scalar) -> Self

Converts to this type from the input type.