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<'a, S> GraphQLObjectType<S> for EnumValuewhere
    S: ScalarValue + 'a,

fn mark()

An arbitrary function without meaning.

impl<'a, S> GraphQLType<S> for EnumValuewhere
    S: ScalarValue + 'a,

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

Returns name of this GraphQLType to expose.

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

Returns MetaType representing this GraphQLType.

impl<'a, S> GraphQLValue<S> for EnumValuewhere
    S: ScalarValue + 'a,

type Context = ()

Context type for this GraphQLValue.

type TypeInfo = ()

Type that may carry additional schema information for this GraphQLValue.

fn type_name<'__i>(&self, info: &'__i Self::TypeInfo) -> Option<&'__i str>

Returns name of the GraphQLType exposed by this GraphQLValue.

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

Resolves the value of a single field on this GraphQLValue.

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

Returns the concrete GraphQLType name for this GraphQLValue being an interface, an union or an object.

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

Resolves this GraphQLValue (being an interface or an union) into a concrete downstream object type.

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

Resolves the provided selection_set against this GraphQLValue.

impl<'a, S> GraphQLValueAsync<S> for EnumValuewhere
    S: ScalarValue + 'a + Send + Sync,
    Self: Sync,

fn resolve_field_async<'b>(
    &'b self,
    info: &'b Self::TypeInfo,
    field: &'b str,
    args: &'b Arguments<'_, S>,
    executor: &'b Executor<'_, '_, Self::Context, S>
) -> BoxFuture<'b, ExecutionResult<S>>where
    S: Send + Sync,

Resolves the value of a single field on this GraphQLValueAsync.

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

Resolves this GraphQLValueAsync (being an interface or an union) into a concrete downstream object type.

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

Resolves the provided selection_set against this GraphQLValueAsync.

impl<'a, S> IsOutputType<S> for EnumValuewhere
    S: ScalarValue + 'a,

fn mark()

An arbitrary function without meaning.