Struct apollo_encoder::InputValueDefinition

pub struct InputValueDefinition { /* private fields */ }

The InputValueDefinition type represents field and directive arguments.

InputValueDefinition: Description? Name : Type DefaultValue? Directives?

Detailed documentation can be found in GraphQL spec.

Example

use apollo_encoder::{Type_, InputValueDefinition};

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

let ty_2 = Type_::List { ty: Box::new(ty_1) };
let mut value = InputValueDefinition::new("cat".to_string(), ty_2);
value.description("Very good cats".to_string());

assert_eq!(
    value.to_string(),
    r#"
    "Very good cats"
    cat: [SpaceProgram]"#
);

Implementations

impl InputValueDefinition

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

Create a new instance of InputValueDefinition.

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

Set the InputValueDefinition’s description.

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

Set the InputValueDef’s default value.

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

Add a directive to InputValueDefinition.

Trait Implementations

impl Clone for InputValueDefinition

fn clone(&self) -> InputValueDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for InputValueDefinition

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

Formats the value using the given formatter.

impl Display for InputValueDefinition

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

Formats the value using the given formatter.

impl PartialEq<InputValueDefinition> for InputValueDefinition

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

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 InputValueDefinition