Struct juniper::meta::Field

pub struct Field<'a, S> { /* private fields */ }

Metadata for a field

Implementations

impl<'a, S> Field<'a, S>

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

Set the description of the field

This overwrites the description if any was previously set.

pub fn push_docstring(self, multiline: &[&str]) -> Field<'a, S>

Adds a (multi)line doc string to the description of the field. Any leading or trailing newlines will be removed.

If the docstring contains newlines, repeated leading tab and space characters will be removed from the beginning of each line.

If the description hasn’t been set, the description is set to the provided line. Otherwise, the doc string is added to the current description after a newline.

pub fn argument(self, argument: Argument<'a, S>) -> Self

Add an argument to the field

Arguments are unordered and can’t contain duplicates by name.

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

Set the field to be deprecated with an optional reason.

This overwrites the deprecation reason if any was previously set.

Trait Implementations

impl<'a, S: Clone> Clone for Field<'a, S>

fn clone(&self) -> Field<'a, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, S: Debug> Debug for Field<'a, S>

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

Formats the value using the given formatter.

impl<'a, S: 'a> GraphQLType<S> for Field<'a, S>where
    S: ScalarValue,
    for<'__b> &'__b S: ScalarRefValue<'__b>,

type Context = SchemaType<'a, S>

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.