Struct dynamic_graphql::dynamic::Object

source ·

pub struct Object { /* private fields */ }

Expand description

A GraphQL object type

Examples

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

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


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

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

Implementations§

source §

impl Object

source

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

Create a GraphQL object type

source

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

Set the description

source

pub fn extends(self) -> Object

Indicates that an object or interface definition is an extension of another definition of that same type.

source

pub fn shareable(self) -> Object

Indicate that an object type’s field is allowed to be resolved by multiple subgraphs

source

pub fn inaccessible(self) -> Object

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

source

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

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

source

pub fn field(self, field: Field) -> Object

Add an field to the object

source

pub fn implement(self, interface: impl Into<String>) -> Object

Add an implement to the object

source

pub fn key(self, fields: impl Into<String>) -> Object

Add an entity key

Examples

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

let obj = Object::new("MyObj")
    .field(Field::new("a", TypeRef::named(TypeRef::INT), |_| {
        FieldFuture::new(async move { Ok(Some(Value::from(10))) })
    }))
    .field(Field::new("b", TypeRef::named(TypeRef::INT), |_| {
        FieldFuture::new(async move { Ok(Some(Value::from(20))) })
    }))
    .field(Field::new("c", TypeRef::named(TypeRef::INT), |_| {
        FieldFuture::new(async move { Ok(Some(Value::from(30))) })
    }))
    .key("a b")
    .key("c");