Struct ArgumentsDefinition

pub struct ArgumentsDefinition { /* private fields */ }

The ArgumentsDefinition type represents an arguments definition

ArgumentsDefinition: ( InputValueDefinition* )

Detailed documentation can be found in GraphQL spec.

Example

use apollo_encoder::{ArgumentsDefinition, InputValueDefinition, Type_};
use indoc::indoc;

let input_value_defs = vec![
    InputValueDefinition::new(
        String::from("first"),
        Type_::NamedType {
            name: String::from("Int"),
        },
    ),
    InputValueDefinition::new(
        String::from("second"),
        Type_::List {
            ty: Box::new(Type_::NamedType {
                name: String::from("Int"),
            }),
        },
    ),
];
let arguments_def = ArgumentsDefinition::with_values(input_value_defs);

assert_eq!(arguments_def.to_string(), r#"(first: Int, second: [Int])"#);

Implementations

impl ArgumentsDefinition

pub fn new() -> Self

Create a new instance of Argument definition.

pub fn with_values(input_values: Vec<InputValueDefinition>) -> Self

Create a new instance of ArgumentsDefinition given Input Value Definitions.

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

Add an InputValueDefinition to Arguments Definition

Trait Implementations

impl Clone for ArgumentsDefinition

fn clone(&self) -> ArgumentsDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ArgumentsDefinition

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

Formats the value using the given formatter.

impl Default for ArgumentsDefinition

fn default() -> ArgumentsDefinition

Returns the “default value” for a type.

impl Display for ArgumentsDefinition

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

Formats the value using the given formatter.

impl PartialEq for ArgumentsDefinition

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

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