Struct Directive

pub struct Directive { /* private fields */ }

The Directive type represents a Directive, it provides a way to describe alternate runtime execution and type validation behavior in a GraphQL document.

Directive: @ Name Arguments?

Detailed documentation can be found in GraphQL spec.

Example

use apollo_encoder::{Argument, Directive, Value};

let mut directive = Directive::new(String::from("myDirective"));
directive.arg(Argument::new(String::from("first"), Value::Int(5)));

assert_eq!(directive.to_string(), "@myDirective(first: 5)");

Implementations

impl Directive

pub fn new(name: String) -> Self

Create an instance of Directive

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

Add an argument to the directive

Trait Implementations

impl Clone for Directive

fn clone(&self) -> Directive

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Directive

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

Formats the value using the given formatter.

impl Display for Directive

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

Formats the value using the given formatter.

impl PartialEq for Directive

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

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