Struct InputField

pub struct InputField { /* private fields */ }

Input Field in a given Input Object. A GraphQL Input Object defines a set of input fields; the input fields are either scalars, enums, or other input objects. Input fields are similar to Fields, but can have a default value.

Example

use apollo_encoder::{Type_, InputField};

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

let mut field = InputField::new("cat".to_string(), ty_1);
field.default_value("\"Norwegian Forest\"".to_string());

assert_eq!(field.to_string(), r#"  cat: CatBreed = "Norwegian Forest""#);

Implementations

impl InputField

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

Create a new instance of InputField.

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

Set the InputField’s description.

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

Set the InputField’s default value.

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

Add a directive.

Trait Implementations

impl Clone for InputField

fn clone(&self) -> InputField

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputField

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

Formats the value using the given formatter.

impl Display for InputField

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

Formats the value using the given formatter.

impl PartialEq for InputField

fn eq(&self, other: &InputField) -> 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 TryFrom<InputValueDefinition> for InputField

fn try_from(node: InputValueDefinition) -> 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 InputField