Struct OperationDefinition

Source
pub struct OperationDefinition { /* private fields */ }
Expand description

The OperationDefinition type represents an operation definition

OperationDefinition: OperationType Name? VariableDefinitions? Directives? SelectionSet

Detailed documentation can be found in GraphQL spec.

§Example

use apollo_encoder::{Argument, Field, InlineFragment, Directive, OperationDefinition, OperationType, Selection, SelectionSet, TypeCondition, Type_, Value, VariableDefinition};
use indoc::indoc;

let selection_set = {
    let sels = vec![
        Selection::Field(Field::new(String::from("first"))),
        Selection::Field(Field::new(String::from("second"))),
    ];
    let mut sel_set = SelectionSet::new();
    sels.into_iter().for_each(|sel| sel_set.selection(sel));

    sel_set
};
let var_def = VariableDefinition::new(
    String::from("variable_def"),
    Type_::List {
        ty: Box::new(Type_::NamedType {
            name: String::from("Int"),
        }),
    },
);
let mut new_op = OperationDefinition::new(OperationType::Query, selection_set);
let mut directive = Directive::new(String::from("testDirective"));
directive.arg(Argument::new(
    String::from("first"),
    Value::String("one".to_string()),
));
new_op.variable_definition(var_def);
new_op.directive(directive);

assert_eq!(
    new_op.to_string(),
    indoc! { r#"
        query($variable_def: [Int]) @testDirective(first: "one") {
          first
          second
        }
    "#}
);

Implementations§

Source§

impl OperationDefinition

Source

pub fn new(operation_type: OperationType, selection_set: SelectionSet) -> Self

Create a new instance of OperationDef

Source

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

Set the operation def’s name.

Source

pub fn variable_definition(&mut self, variable_definition: VariableDefinition)

Add a variable definitions.

Source

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

Add a directive.

Source

pub fn shorthand(&mut self)

Set this operation as a query shorthand If a document contains only one operation and that operation is a query which defines no variables and contains no directives then that operation may be represented in a short-hand form which omits the query keyword and operation name. Be careful, it will automatically drop variable definitions and directives

Trait Implementations§

Source§

impl Clone for OperationDefinition

Source§

fn clone(&self) -> OperationDefinition

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for OperationDefinition

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for OperationDefinition

Source§

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

Formats the value using the given formatter. Read more
Source§

impl TryFrom<OperationDefinition> for OperationDefinition

Source§

fn try_from(node: OperationDefinition) -> 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.

Source§

type Error = FromError

The type returned in the event of a conversion error.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.