Struct apollo_encoder::EnumDef

pub struct EnumDef { /* fields omitted */ }

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::{EnumValue, EnumDef};

let mut enum_ty_1 = EnumValue::new("CAT_TREE".to_string());
enum_ty_1.description(Some("Top bunk of a cat tree.".to_string()));
let enum_ty_2 = EnumValue::new("BED".to_string());
let mut enum_ty_3 = EnumValue::new("CARDBOARD_BOX".to_string());
enum_ty_3.deprecated(Some("Box was recycled.".to_string()));

let mut enum_ = EnumDef::new("NapSpots".to_string());
enum_.description(Some("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 EnumDef

pub fn new(name: String) -> Self

Create a new instance of Enum Definition.

pub fn description(&mut self, description: Option<String>)

Set the Enum Definition’s description.

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

Set the Enum Definitions’s values.

Trait Implementations

impl Clone for EnumDef

fn clone(&self) -> EnumDef

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EnumDef

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

Formats the value using the given formatter.

impl Display for EnumDef

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

Formats the value using the given formatter.

impl PartialEq<EnumDef> for EnumDef

fn eq(&self, other: &EnumDef) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &EnumDef) -> bool

This method tests for !=.

impl StructuralPartialEq for EnumDef