Struct warpgrapher::engine::config::Configuration

pub struct Configuration {
    pub model: Vec<Type>,
    // some fields omitted
}

Configuration for a Warpgrapher data model. The configuration contains the version of the Warpgrapher configuration file format, a vector of Type structures, and a vector of Endpoint structures.

Examples

  
let c = Configuration::new(1, Vec::new(), Vec::new());

Fields

model: Vec<Type>

A vector of Type structures, each defining one type in the data model

Implementations

impl Configuration

pub fn new(
    version: i32,
    model: Vec<Type>,
    endpoints: Vec<Endpoint>
) -> Configuration

Creates a new Configuration data structure with the version, Type vector, and Endpoint vector provided as arguments.

Examples

let c = Configuration::new(1, Vec::new(), Vec::new());

pub fn endpoints(&self) -> Iter<'_, Endpoint>

Returns an iterator over the Endpoint structs defining custom root endpoints in the GraphQL schema

Examples

let c = Configuration::new(1, Vec::new(), Vec::new());
for e in c.endpoints() {
    let _name = e.name();
}

pub fn types(&self) -> Iter<'_, Type>

Returns an iterator over the Type structs defining types in the GraphQL schema

Examples

let c = Configuration::new(1, Vec::new(), Vec::new());
for t in c.types() {
    let _name = t.name();
}

pub fn validate(&self) -> Result<(), Error>

Validates the Configuration data structure. Checks that there are no duplicate Endpoint or Type items, and that the Endpoint input/output types are defined in the model. Returns () if there are no validation errors.

Errors

Returns an Error variant ConfigItemDuplicated if there is more than one type or more than one endpoint that use the same name.

Returns an Error variant ConfigItemReserved if a named configuration item, such as an endpoint or type, has a name that is a reserved word, such as “ID” or the name of a GraphQL scalar type.

Example

let config = Configuration::new(1, Vec::new(), Vec::new());
config.validate();

pub fn version(&self) -> i32

Returns the version number of the configuration format used for the configuration

Examples

let c = Configuration::new(1, Vec::new(), Vec::new());

assert_eq!(1, c.version());

Trait Implementations

impl Clone for Configuration

fn clone(&self) -> Configuration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Configuration

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

Formats the value using the given formatter.

impl Default for Configuration

fn default() -> Configuration

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Configuration

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

Deserialize this value from the given Serde deserializer.

impl Hash for Configuration

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 Configuration

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

This method returns an Ordering between self and other.

#[must_use]

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

Compares and returns the maximum of two values.

#[must_use]

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

Compares and returns the minimum of two values.

#[must_use]

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

Restrict a value to a certain interval.

impl PartialEq<Configuration> for Configuration

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

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

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

This method tests for !=.

impl PartialOrd<Configuration> for Configuration

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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 Configuration

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 Configuration

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Configuration, Error>

Performs the conversion.

impl TryFrom<File> for Configuration

type Error = Error

The type returned in the event of a conversion error.

fn try_from(f: File) -> Result<Configuration, Error>

Performs the conversion.

impl TryFrom<String> for Configuration

type Error = Error

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Configuration, Error>

Performs the conversion.

impl Eq for Configuration

impl StructuralEq for Configuration

impl StructuralPartialEq for Configuration