Struct async_graphql::dynamic::Field

pub struct Field { /* private fields */ }

Available on crate feature dynamic-schema only.

A GraphQL field

Implementations

impl Field

pub fn new<N, T, F>(name: N, ty: T, resolver_fn: F) -> Selfwhere N: Into<String>, T: Into<TypeRef>, F: for<'a> Fn(ResolverContext<'a>) -> FieldFuture<'a> + Send + Sync + 'static,

Create a GraphQL field

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

Set the description

pub fn deprecation(self, reason: Option<&str>) -> Self

Set the description

pub fn external(self) -> Self

Mark a field as owned by another service. This allows service A to use fields from service B while also knowing at runtime the types of that field.

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

Annotate the required input fieldset from a base type for a resolver. It is used to develop a query plan where the required fields may not be needed by the client, but the service may need additional information from other services.

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

Annotate the expected returned fieldset from a field on a base type that is guaranteed to be selectable by the gateway.

pub fn shareable(self) -> Self

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

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 override_from(self, name: impl Into<String>) -> Self

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

pub fn argument(self, input_value: InputValue) -> Self

Add an argument to the field

Trait Implementations

impl Debug for Field

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

Formats the value using the given formatter.