Struct ScalarDefinition

pub struct ScalarDefinition { /* private fields */ }

Represents scalar types such as Int, String, and Boolean. Scalars cannot have fields.

ScalarTypeDefinition: Description? scalar Name Directives?

Detailed documentation can be found in GraphQL spec.

Example

use apollo_encoder::ScalarDefinition;

let mut scalar = ScalarDefinition::new("NumberOfTreatsPerDay".to_string());
scalar.description(
    "Int representing number of treats received.".to_string(),
);

assert_eq!(
    scalar.to_string(),
    r#""Int representing number of treats received."
scalar NumberOfTreatsPerDay
"#
);

Implementations

impl ScalarDefinition

pub fn new(name: String) -> Self

Create a new instance of Scalar Definition.

pub fn description(&mut self, description: String)

Set the ScalarDef’s description.

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

Add a directive.

pub fn extend(&mut self)

Set the scalar as an extension

Trait Implementations

impl Clone for ScalarDefinition

fn clone(&self) -> ScalarDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScalarDefinition

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

Formats the value using the given formatter.

impl Display for ScalarDefinition

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

Formats the value using the given formatter.

impl PartialEq for ScalarDefinition

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

fn try_from(node: ScalarTypeDefinition) -> 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 TryFrom<ScalarTypeExtension> for ScalarDefinition

fn try_from(node: ScalarTypeExtension) -> 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 ScalarDefinition