Struct warpgrapher::engine::config::Endpoint

pub struct Endpoint { /* private fields */ }

Configuration item for custom endpoints

Examples

let e = Endpoint::new("CountItems".to_string(), EndpointClass::Query, None,
    EndpointType::new(TypeDef::Scalar(GraphqlType::Int), false, true));

Implementations

impl Endpoint

pub fn new(
    name: String,
    class: EndpointClass,
    input: Option<EndpointType>,
    output: EndpointType
) -> Endpoint

Creates a new configuration item for a custom GraphQL endpoint

Examples

let e = Endpoint::new("CountItems".to_string(), EndpointClass::Query, None,
    EndpointType::new(TypeDef::Scalar(GraphqlType::Int), false, true));

pub fn class(&self) -> &EndpointClass

Returns the EndpointClass of a custom GraphQL endpoint, indicating whether the custom endpoint is a Query or Mutation.

Examples

let e = Endpoint::new("CountItems".to_string(), EndpointClass::Query, None,
    EndpointType::new(TypeDef::Scalar(GraphqlType::Int), false, true));

assert_eq!(&EndpointClass::Query, e.class());

pub fn name(&self) -> &str

Returns the name of a custom GraphQL endpoint.

Examples

let e = Endpoint::new("CountItems".to_string(), EndpointClass::Query, None,
    EndpointType::new(TypeDef::Scalar(GraphqlType::Int), false, true));

assert_eq!("CountItems", e.name());

pub fn input(&self) -> Option<&EndpointType>

Returns the optional type definition of the input to a custom endpoint. A value of None indicates that the GraphQL endpoint does not take an input.

Examples

let e = Endpoint::new("CountItems".to_string(), EndpointClass::Query, None,
    EndpointType::new(TypeDef::Scalar(GraphqlType::Int), false, true));

assert!(e.input().is_none());

pub fn output(&self) -> &EndpointType

Returns the type definition of the output for a custom endpoint

Examples

let e = Endpoint::new("CountItems".to_string(), EndpointClass::Query, None,
    EndpointType::new(TypeDef::Scalar(GraphqlType::Int), false, true));

assert_eq!(&EndpointType::new(TypeDef::Scalar(GraphqlType::Int), false, true),
    e.output());

Trait Implementations

impl Clone for Endpoint

fn clone(&self) -> Endpoint

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Endpoint

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Endpoint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Hash for Endpoint

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, 

Feeds a slice of this type into the given Hasher.

impl Ord for Endpoint

fn cmp(&self, other: &Endpoint) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self where
    Self: PartialOrd<Self>, 

Restrict a value to a certain interval.

impl PartialEq<Endpoint> for Endpoint

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

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

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

This method tests for !=.

impl PartialOrd<Endpoint> for Endpoint

fn partial_cmp(&self, other: &Endpoint) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Endpoint

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for Endpoint

fn try_from(yaml: &str) -> Result<Endpoint, Error>

Creates a new Endpoint struct from a yaml-formatted string.

Errors

Returns an Error variant YamlDeserializationFailed if the yaml-formatted string is improperly formatted.

Examples

use warpgrapher::engine::config::{Endpoint};

use std::convert::TryFrom;
let t = Endpoint::try_from("
name: RegisterUser
class: Mutation
input:
  type: UserInput
output:
  type: User
").unwrap();

type Error = Error

The type returned in the event of a conversion error.

impl Eq for Endpoint

impl StructuralEq for Endpoint

impl StructuralPartialEq for Endpoint