Struct Field

pub struct Field {
    pub definition: Node<FieldDefinition>,
    pub alias: Option<Name>,
    pub name: Name,
    pub arguments: Vec<Node<Argument>>,
    pub directives: DirectiveList,
    pub selection_set: SelectionSet,
}

A Field selection, linked to the corresponding field definition in the schema.

Fields

definition: Node<FieldDefinition>

The definition of this field in an object type or interface type definition in the schema

alias: Option<Name>

name: Name

arguments: Vec<Node<Argument>>

directives: DirectiveList

selection_set: SelectionSet

Implementations

impl Field

pub fn new(name: Name, definition: Node<FieldDefinition>) -> Self

Create a new field with the given name and type.

See SelectionSet::new_field too look up the type in a schema instead.

pub fn with_alias(self, alias: Name) -> Self

pub fn with_opt_alias(self, alias: Option<Name>) -> Self

pub fn with_directive(self, directive: impl Into<Node<Directive>>) -> Self

pub fn with_directives( self, directives: impl IntoIterator<Item = Node<Directive>>, ) -> Self

pub fn with_argument(self, name: Name, value: impl Into<Node<Value>>) -> Self

pub fn with_arguments( self, arguments: impl IntoIterator<Item = Node<Argument>>, ) -> Self

pub fn with_selection(self, selection: impl Into<Selection>) -> Self

pub fn with_selections( self, selections: impl IntoIterator<Item = impl Into<Selection>>, ) -> Self

pub fn response_key(&self) -> &Name

Returns the response key for this field: the alias if there is one, or the name

pub fn ty(&self) -> &Type

The type of this field, from the field definition

pub fn inner_type_def<'a>(&self, schema: &'a Schema) -> Option<&'a ExtendedType>

Look up in schema the definition of the inner type of this field.

The inner type is ty() after unwrapping non-null and list markers.

pub fn argument_by_name( &self, name: &str, ) -> Result<&Node<Value>, ArgumentByNameError>

Returns the value of the argument named name, accounting for nullability and for the default value in schema’s directive definition.

pub fn specified_argument_by_name(&self, name: &str) -> Option<&Node<Value>>

Returns the value of the argument named name, as specified in the field selection.

Returns None if the field selection does not specify this argument.

If the field definition makes this argument nullable or defines a default value, consider using argument_by_name instead.

pub fn serialize(&self) -> Serialize<'_, Self>

Returns a builder that has chaining methods for setting serialization configuration, and implements the Display and ToString traits by writing GraphQL syntax.

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Field

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

Formats the value using the given formatter.

impl Display for Field

Serialize to GraphQL syntax with the default configuration

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

Formats the value using the given formatter.

impl From<Field> for Selection

fn from(value: Field) -> Self

Converts to this type from the input type.

impl Hash for Field

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for Field

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

impl StructuralPartialEq for Field