Struct async_graphql::dynamic::InputObject

pub struct InputObject { /* private fields */ }

Available on crate feature dynamic-schema only.

A GraphQL input object type

Examples

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

let my_input = InputObject::new("MyInput")
    .field(InputValue::new("a", TypeRef::named_nn(TypeRef::INT)))
    .field(InputValue::new("b", TypeRef::named_nn(TypeRef::INT)));

let query = Object::new("Query").field(
    Field::new("add", TypeRef::named_nn(TypeRef::INT), |ctx| {
        FieldFuture::new(async move {
            let input = ctx.args.try_get("input")?;
            let input = input.object()?;
            let a = input.try_get("a")?.i64()?;
            let b = input.try_get("b")?.i64()?;
            Ok(Some(Value::from(a + b)))
        })
    })
    .argument(InputValue::new("input", TypeRef::named_nn(my_input.type_name())))
);


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

assert_eq!(
   schema
       .execute("{ add(input: { a: 10, b: 20 }) }")
       .await
       .into_result()
       .unwrap()
       .data,
   value!({ "add": 30 })
);

Implementations

impl InputObject

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

Create a GraphQL input object 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 field(self, field: InputValue) -> Self

Add a field

pub fn oneof(self) -> Self

Indicates this Input Object is a OneOf Input Object

pub fn type_name(&self) -> &str

Returns the type name

Trait Implementations

impl Debug for InputObject

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

Formats the value using the given formatter.

impl From<InputObject> for Type

fn from(obj: InputObject) -> Self

Converts to this type from the input type.