Struct apollo_encoder::FieldDefinition

pub struct FieldDefinition { /* private fields */ }

The FieldDefinition type represents each field definition in an Object definition or Interface type definition.

FieldDefinition: Description? Name ArgumentsDefinition? : Type Directives?

Detailed documentation can be found in GraphQL spec.

Example

use apollo_encoder::{Type_, FieldDefinition, InputValueDefinition};

let ty_1 = Type_::NamedType {
    name: "CatBreed".to_string(),
};

let mut field = FieldDefinition::new("cat".to_string(), ty_1);

let value_1 = Type_::NamedType {
    name: "CatBreed".to_string(),
};

let arg = InputValueDefinition::new("breed".to_string(), value_1);

field.arg(arg);

assert_eq!(
    field.to_string(),
    r#"  cat(breed: CatBreed): CatBreed"#
);

Implementations

impl FieldDefinition

pub fn new(name: String, type_: Type_) -> Self

Create a new instance of Field.

pub fn description(&mut self, description: String)

Set the Field’s description.

pub fn arg(&mut self, arg: InputValueDefinition)

Set the Field’s arguments.

pub fn directive(&mut self, directive: Directive)

Add a directive.

Trait Implementations

impl Clone for FieldDefinition

fn clone(&self) -> FieldDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldDefinition

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

Formats the value using the given formatter.

impl Display for FieldDefinition

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

Formats the value using the given formatter.

impl PartialEq<FieldDefinition> for FieldDefinition

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<FieldDefinition> for FieldDefinition

fn try_from(node: FieldDefinition) -> Result<Self, Self::Error>

Create an apollo-encoder node from an apollo-parser one.

Errors

This returns an error if the apollo-parser tree is not valid. The error doesn’t have much context due to TryFrom API constraints: validate the parse tree before using TryFrom if granular errors are important to you.

type Error = FromError

The type returned in the event of a conversion error.

impl StructuralPartialEq for FieldDefinition