Struct GraphQLFieldConfig 

pub struct GraphQLFieldConfig {

    pub name: Option<String>,
    pub description: Option<String>,
    pub skip: bool,
    pub deprecation: Option<String>,
    pub complexity: Option<ComplexityConfig>,
    pub guard: Option<String>,
    pub resolver: Option<String>,
    pub directives: Vec<GraphQLDirective>,
    pub derived: bool,
    pub shareable: bool,
    pub external: bool,
    pub provides: Option<String>,
    pub requires: Option<String>,
    pub key: bool,
}

GraphQL-specific configuration for a field.

Fields

name: Option<String>

Custom GraphQL field name.

description: Option<String>

Description override.

skip: bool

Whether to skip this field in GraphQL.

deprecation: Option<String>

Deprecation reason.

complexity: Option<ComplexityConfig>

Query complexity for this field.

guard: Option<String>

Guard/authorization expression.

resolver: Option<String>

Custom resolver function.

directives: Vec<GraphQLDirective>

Directives to apply.

derived: bool

Whether this field is derived/computed.

shareable: bool

Shareable across subgraphs (federation).

external: bool

External field (federation).

provides: Option<String>

Provides fields (federation).

requires: Option<String>

Requires fields (federation).

key: bool

Field is used as entity key (federation).

Implementations

impl GraphQLFieldConfig

pub fn new() -> GraphQLFieldConfig

Create new field config with defaults.

pub fn with_name(self, name: impl Into<String>) -> GraphQLFieldConfig

Set custom name.

pub fn skip(self) -> GraphQLFieldConfig

Mark as skipped.

pub fn deprecated(self, reason: impl Into<String>) -> GraphQLFieldConfig

Set deprecation reason.

pub fn derived(self) -> GraphQLFieldConfig

Set as derived field.

Trait Implementations

impl Clone for GraphQLFieldConfig

fn clone(&self) -> GraphQLFieldConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for GraphQLFieldConfig

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

Formats the value using the given formatter.

impl Default for GraphQLFieldConfig

fn default() -> GraphQLFieldConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GraphQLFieldConfig

fn deserialize<__D>( __deserializer: __D, ) -> Result<GraphQLFieldConfig, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for GraphQLFieldConfig

fn eq(&self, other: &GraphQLFieldConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for GraphQLFieldConfig

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for GraphQLFieldConfig