Struct juniper::meta::EnumValue

pub struct EnumValue {
    pub name: String,
    pub description: Option<String>,
    pub deprecation_status: DeprecationStatus,
}

Metadata for a single value in an enum

Fields

name: String

The name of the enum value

This is the string literal representation of the enum in responses.

description: Option<String>

The optional description of the enum value.

Note: this is not the description of the enum itself; it’s the description of this enum value.

deprecation_status: DeprecationStatus

Whether the field is deprecated or not, with an optional reason.

Implementations

impl EnumValue

pub fn new(name: &str) -> EnumValue

Construct a new enum value with the provided name

pub fn description(self, description: &str) -> EnumValue

Set the description of the enum value

This overwrites the description if any was previously set.

pub fn deprecated(self, reason: Option<&str>) -> Self

Set the enum value to be deprecated with an optional reason.

This overwrites the deprecation reason if any was previously set.

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<S> GraphQLType<S> for EnumValuewhere
    S: ScalarValue,
    for<'__b> &'__b S: ScalarRefValue<'__b>,

type Context = ()

The expected context type for this GraphQL type

type TypeInfo = ()

Type that may carry additional schema information

fn name(_: &Self::TypeInfo) -> Option<&str>

The name of the GraphQL type to expose.

fn meta<'r>(
    info: &Self::TypeInfo,
    registry: &mut Registry<'r, S>
) -> MetaType<'r, S>where
    for<'__b> &'__b S: ScalarRefValue<'__b>,
    S: 'r,

The meta type representing this GraphQL type.

fn concrete_type_name(&self, _: &Self::Context, _: &Self::TypeInfo) -> String

Return the concrete type name for this instance/union.

fn resolve_field(
    &self,
    info: &Self::TypeInfo,
    field: &str,
    args: &Arguments<'_, S>,
    executor: &Executor<'_, Self::Context, S>
) -> ExecutionResult<S>

Resolve the value of a single field on this type.

fn resolve_into_type(
    &self,
    info: &Self::TypeInfo,
    type_name: &str,
    selection_set: Option<&[Selection<'_, S>]>,
    executor: &Executor<'_, Self::Context, S>
) -> ExecutionResult<S>

Resolve this interface or union into a concrete type

fn resolve(
    &self,
    info: &Self::TypeInfo,
    selection_set: Option<&[Selection<'_, S>]>,
    executor: &Executor<'_, Self::Context, S>
) -> Value<S>

Resolve the provided selection set against the current object.