Struct Field

pub struct Field { /* private fields */ }

The __Field type represents each field in an Object or Interface type.

Field: Alias? Name Arguments? Directives? SelectionSet?

Detailed documentation can be found in GraphQL spec.

Example

use apollo_encoder::Field;

let mut field = Field::new("myField".to_string());
field.alias(Some("myAlias".to_string()));

assert_eq!(field.to_string(), r#"myAlias: myField"#);

Implementations

impl Field

pub fn new(name: String) -> Self

Create an instance of Field

pub fn alias(&mut self, alias: Option<String>)

Set an alias to a field name

pub fn directive(&mut self, directive: Directive)

Add a directive to a field

pub fn argument(&mut self, argument: Argument)

Add an argument to a field

pub fn selection_set(&mut self, selection_set: Option<SelectionSet>)

Set a selection set to a field

Trait Implementations

impl Clone for Field

fn clone(&self) -> Field

Returns a copy of the value.

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

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

Formats the value using the given formatter.

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 TryFrom<Field> for Field

fn try_from(node: Field) -> Result<Self, Self::Error>

Create an apollo-encoder node from an apollo-parser one.

Errors

This returns an error if the apollo-parser tree is not valid. The error doesn’t have much context due to TryFrom API constraints: validate the parse tree before using TryFrom if granular errors are important to you.

type Error = FromError

The type returned in the event of a conversion error.

impl StructuralPartialEq for Field