Struct warpgrapher::engine::config::Configuration [−][src]
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
[src]
pub fn new(
version: i32,
model: Vec<Type>,
endpoints: Vec<Endpoint>
) -> Configuration
[src]
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>
[src]
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>
[src]
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>
[src]
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
[src]
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
[src]
fn clone(&self) -> Configuration
[src]
pub fn clone_from(&mut self, source: &Self)
1.0.0[src]
impl Debug for Configuration
[src]
impl Default for Configuration
[src]
fn default() -> Configuration
[src]
impl<'de> Deserialize<'de> for Configuration
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Eq for Configuration
[src]
impl Hash for Configuration
[src]
fn hash<__H: Hasher>(&self, state: &mut __H)
[src]
pub fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
impl Ord for Configuration
[src]
fn cmp(&self, other: &Configuration) -> Ordering
[src]
#[must_use]pub fn max(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn min(self, other: Self) -> Self
1.21.0[src]
#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self
1.50.0[src]
impl PartialEq<Configuration> for Configuration
[src]
fn eq(&self, other: &Configuration) -> bool
[src]
fn ne(&self, other: &Configuration) -> bool
[src]
impl PartialOrd<Configuration> for Configuration
[src]
fn partial_cmp(&self, other: &Configuration) -> Option<Ordering>
[src]
#[must_use]pub fn lt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn le(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn gt(&self, other: &Rhs) -> bool
1.0.0[src]
#[must_use]pub fn ge(&self, other: &Rhs) -> bool
1.0.0[src]
impl Serialize for Configuration
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralEq for Configuration
[src]
impl StructuralPartialEq for Configuration
[src]
impl TryFrom<&'_ str> for Configuration
[src]
type Error = Error
The type returned in the event of a conversion error.
fn try_from(s: &str) -> Result<Configuration, Error>
[src]
impl TryFrom<File> for Configuration
[src]
type Error = Error
The type returned in the event of a conversion error.
fn try_from(f: File) -> Result<Configuration, Error>
[src]
impl TryFrom<String> for Configuration
[src]
Auto Trait Implementations
impl RefUnwindSafe for Configuration
impl Send for Configuration
impl Sync for Configuration
impl Unpin for Configuration
impl UnwindSafe for Configuration
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> DeserializeOwned for T where
T: for<'de> Deserialize<'de>,
[src]
T: for<'de> Deserialize<'de>,
impl<Q, K> Equivalent<K> for Q where
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
[src]
K: Borrow<Q> + ?Sized,
Q: Eq + ?Sized,
pub fn equivalent(&self, key: &K) -> bool
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
type Owned = T
The resulting type after obtaining ownership.
pub fn to_owned(&self) -> T
[src]
pub fn clone_into(&self, target: &mut T)
[src]
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,