Struct Field

pub struct Field<'a> {
    pub alias: Option<&'a str>,
    pub name: &'a str,
    pub arguments: Arguments<'a>,
    pub directives: Directives<'a>,
    pub selection_set: SelectionSet<'a>,
}

AST Node for Fields, which can be likened to functions or properties on a parent object.

In JSON this would represent a property in a JSON object. Reference

Fields

alias: Option<&'a str>

A Field’s alias, which is used to request information under a different name than the Field’s name. Reference

name: &'a str

A Field’s name, which represents a resolver on a GraphQL schema’s object type.

arguments: Arguments<'a>

Arguments that are passed to a Field.

When no Arguments are passed, this will be an empty list, as can be checked using Arguments::is_empty. See: Arguments

directives: Directives<'a>

Directives that are annotating this Field.

When no Directives are present, this will be an empty list, as can be checked using Directives::is_empty. See: Directives

selection_set: SelectionSet<'a>

A sub-Selection Set that is passed below this field to add selections to this field’s returned GraphQL object type.

When no selections are present, this will be an empty list, as can be checked using SelectionSet::is_empty. See: SelectionSet

Implementations

impl<'a> Field<'a>

pub fn alias_or_name(&self) -> &'a str

Get the alias of the field, if present, otherwise get the name.

pub fn new_leaf(ctx: &'a ASTContext, name: &'a str) -> Self

Creates a new leaf field with the given name.

All sub-lists, like arguments, directives and selection_set will be created as empty defaults.

pub fn new_aliased_leaf( ctx: &'a ASTContext, alias: &'a str, name: &'a str, ) -> Self

Creates a new leaf field with the given name and alias.

All sub-lists, like arguments, directives and selection_set will be created as empty defaults.

Trait Implementations

impl<'a> Clone for Field<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Field<'a>

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

Formats the value using the given formatter.

impl<'a> From<Field<'a>> for Selection<'a>

fn from(x: Field<'a>) -> Self

Converts to this type from the input type.

impl<'a> PartialEq for Field<'a>

fn eq(&self, other: &Field<'a>) -> 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<'a> PrintNode for Field<'a>

fn write_to_buffer(&self, level: usize, buffer: &mut dyn Write) -> Result

Write an AST node to a buffer implementing the Write trait.

fn print(&self) -> String

Print an AST Node to source text as a String allocated on the heap.

impl<'arena> Skippable<'arena> for Field<'arena>

fn should_include(&'arena self, variables: Option<&Variables<'arena>>) -> bool

Resolves @include and @skip directives to a flag on whether an AST node must be skipped during execution.

impl<'arena> WithDirectives<'arena> for Field<'arena>

fn directives(&self) -> &Directives<'arena>

impl<'a> StructuralPartialEq for Field<'a>