Struct apollo_encoder::VariableDefinition

pub struct VariableDefinition { /* private fields */ }

The VariableDefinition type represents a variable definition

VariableDefinition: VariableName : Type DefaultValue? Directives?

Detailed documentation can be found in GraphQL spec.

Example

use apollo_encoder::{Type_, Value, VariableDefinition};

let mut variable = VariableDefinition::new(
    String::from("my_var"),
    Type_::NamedType {
        name: String::from("MyType"),
    },
);
variable.default_value(Value::Object(vec![
    (String::from("first"), Value::Int(25)),
    (String::from("second"), Value::String(String::from("test"))),
]));

assert_eq!(
    variable.to_string(),
    String::from(r#"$my_var: MyType = { first: 25, second: "test" }"#)
);

Implementations

impl VariableDefinition

pub fn new(variable: String, ty: Type_) -> Self

Create an instance of VariableDefinition

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

Set a default value to the variable

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

Add a directive

Trait Implementations

impl Debug for VariableDefinition

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

Formats the value using the given formatter.

impl Display for VariableDefinition

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

Formats the value using the given formatter.

impl TryFrom<VariableDefinition> for VariableDefinition

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