Struct warpgrapher::engine::config::Config

pub struct Config {
    pub version: i32,
    pub model: Vec<Type>,
    pub endpoints: Vec<Endpoint>,
}

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

Examples

use warpgrapher::engine::config::Config;

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

Fields

version: i32

Version of the Warpgrapher configuration file format used

model: Vec<Type>

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

endpoints: Vec<Endpoint>

A vector of Endpoint structures, each defining an a custom root endpoint in the graphql schema

Implementations

impl Config

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

Creates a new, empty Config data structure

Examples

use warpgrapher::engine::config::Config;

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

pub fn default() -> Config

Creates a new, Config data structure with default values

Examples

use warpgrapher::engine::config::Config;

let config = Config::default();

pub fn from_string(data: String) -> Result<Config, Error>

Creates a new Config data structure from a yaml formatted config string.

pub fn from_file(path: String) -> Result<Config, Error>

Creates a new Config data structure from the contents of the specified config file. Returns error if the config file could not be opened or deserialized.

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

Validates the Config data structure. Checks to verify no duplicate Endpoint or Type, and that the Endpoint input/output types are defined in the model. Returns a Result<(), Error> where the error could be one of:

• [ConfigTypeDuplicateError] if any Type is defined twice in the configuration.
• [ConfigEndpointDuplicateError] if any Endpoint Type is defined twice in the configuration.
• [ConfigEndpointMissingTypeError] if an Endpoint does not have a corresponding Type defined.

#Example

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

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

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

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

Deserialize this value from the given Serde deserializer.

impl Eq for Config

impl Hash for Config

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 Config

fn cmp(&self, other: &Config) -> 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

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<Config> for Config

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

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

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

This method tests for !=.

impl PartialOrd<Config> for Config

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

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

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

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

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

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

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

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

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

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

impl Serialize for Config

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

Serialize this value into the given Serde serializer.

impl StructuralEq for Config

impl StructuralPartialEq for Config