Struct async_graphql::dynamic::Interface

pub struct Interface { /* private fields */ }

Available on crate feature dynamic-schema only.

A GraphQL interface type

Implementations

impl Interface

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

Create a GraphQL interface type

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

Set the description

pub fn extends(self) -> Self

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

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: InterfaceField) -> Self

Add a field to the interface type

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

Add an implement to the interface type

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

Add an entity key

See also: Object::key

pub fn type_name(&self) -> &str

Returns the type name

Trait Implementations

impl Debug for Interface

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

Formats the value using the given formatter.

impl From<Interface> for Type

fn from(interface: Interface) -> Self

Converts to this type from the input type.