Struct EnumValue

pub struct EnumValue { /* private fields */ }

The EnumValue type represents one of possible values of an enum.

EnumValueDefinition: Description? EnumValue Directives?

Detailed documentation can be found in GraphQL spec.

Example

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

let mut enum_ty = EnumValue::new("CARDBOARD_BOX".to_string());
enum_ty.description("Box nap spot.".to_string());
let mut deprecated_directive = Directive::new(String::from("deprecated"));
deprecated_directive.arg(Argument::new(
    String::from("reason"),
    Value::String(String::from(
        "Box was recycled.",
    )),
));
enum_ty.directive(deprecated_directive);

assert_eq!(
    enum_ty.to_string(),
    r#"  "Box nap spot."
  CARDBOARD_BOX @deprecated(reason: "Box was recycled.")"#
);

Implementations

impl EnumValue

pub fn new(name: String) -> Self

Create a new instance of EnumValue.

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

Set the Enum Value’s description.

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

Add a directive.

Trait Implementations

impl Clone for EnumValue

fn clone(&self) -> EnumValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnumValue

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

Formats the value using the given formatter.

impl Display for EnumValue

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

Formats the value using the given formatter.

impl PartialEq for EnumValue

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

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