Struct EnumDefinition

pub struct EnumDefinition { /* private fields */ }

Enums are special scalars that can only have a defined set of values.

EnumTypeDefinition: Description? enum Name Directives? EnumValuesDefinition?

Detailed documentation can be found in GraphQL spec.

Example

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

let mut enum_ty_1 = EnumValue::new("CAT_TREE".to_string());
enum_ty_1.description("Top bunk of a cat tree.".to_string());
let enum_ty_2 = EnumValue::new("BED".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."))));
let mut enum_ty_3 = EnumValue::new("CARDBOARD_BOX".to_string());
enum_ty_3.directive(deprecated_directive);

let mut enum_ = EnumDefinition::new("NapSpots".to_string());
enum_.description("Favourite cat nap spots.".to_string());
enum_.value(enum_ty_1);
enum_.value(enum_ty_2);
enum_.value(enum_ty_3);

assert_eq!(
    enum_.to_string(),
    r#""Favourite cat nap spots."
enum NapSpots {
  "Top bunk of a cat tree."
  CAT_TREE
  BED
  CARDBOARD_BOX @deprecated(reason: "Box was recycled.")
}
"#
);

Implementations

impl EnumDefinition

pub fn new(name: String) -> Self

Create a new instance of Enum Definition.

pub fn extend(&mut self)

Set the enum type as an extension

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

Set the Enum Definition’s description.

pub fn value(&mut self, value: EnumValue)

Set the Enum Definitions’s values.

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

Add a directive.

Trait Implementations

impl Clone for EnumDefinition

fn clone(&self) -> EnumDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnumDefinition

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

Formats the value using the given formatter.

impl Display for EnumDefinition

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

Formats the value using the given formatter.

impl PartialEq for EnumDefinition

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

fn try_from(node: EnumTypeDefinition) -> 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 TryFrom<EnumTypeExtension> for EnumDefinition

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