Struct apollo_encoder::UnionDefinition

pub struct UnionDefinition { /* private fields */ }

UnionDefinitions are an abstract type where no common fields are declared.

UnionDefTypeDefinition: Description? union Name Directives? UnionDefMemberTypes?

Detailed documentation can be found in GraphQL spec.

Example

use apollo_encoder::UnionDefinition;

let mut union_ = UnionDefinition::new("Pet".to_string());
union_.member("Cat".to_string());
union_.member("Dog".to_string());

assert_eq!(
    union_.to_string(),
r#"union Pet = Cat | Dog
"#
);

Implementations

impl UnionDefinition

pub fn new(name: String) -> Self

Create a new instance of a UnionDef.

pub fn extend(&mut self)

Set the union type as an extension

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

Set the UnionDefs description.

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

Add a directive

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

Set a UnionDef member.

Trait Implementations

impl Clone for UnionDefinition

fn clone(&self) -> UnionDefinition

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UnionDefinition

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

Formats the value using the given formatter.

impl Display for UnionDefinition

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

Formats the value using the given formatter.

impl PartialEq<UnionDefinition> for UnionDefinition

fn eq(&self, other: &UnionDefinition) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<UnionTypeDefinition> for UnionDefinition

fn try_from(node: UnionTypeDefinition) -> 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<UnionTypeExtension> for UnionDefinition

fn try_from(node: UnionTypeExtension) -> 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 UnionDefinition