Struct warpgrapher::engine::config::Type

pub struct Type { /* fields omitted */ }

Configuration item for a GraphQL type. In back-end storage, the type is recorded in a label attached to the graph node.

Examples

let t = Type::new(
    "User".to_string(),
    vec!(Property::new("name".to_string(), false, "String".to_string(), true, false, None, None),
         Property::new("role".to_string(), false, "String".to_string(), true, false, None, None)),
    vec!(),
    EndpointsFilter::all()
);

Implementations

impl Type

pub fn new(
    name: String,
    props: Vec<Property>,
    rels: Vec<Relationship>,
    endpoints: EndpointsFilter
) -> Type

Creates a new Type struct.

Arguments

• name - the name of the type, which will be recorded as the label on a node in the graph back-end
• props - a vector of Property structs describing the properties on the node
• rels - a vector of Relationship structs describing the outgoing relationships from this node type
• endpoints - an EndpointsFilter struct describing which CRUD operations should be generated automatically for this node type.

Examples

let t = Type::new(
    "User".to_string(),
    vec!(Property::new("name".to_string(), false, "String".to_string(), true, false, None, None),
         Property::new("role".to_string(), false, "String".to_string(), true, false, None, None)),
    vec!(),
    EndpointsFilter::all()
);

pub fn name(&self) -> &str

Returns the name of the type. This type name is used as the label on nodes of this type in the graph database storage back-end.

Examples

let t = Type::new(
    "User".to_string(),
    vec!(Property::new("name".to_string(), false, "String".to_string(), true, false, None, None),
         Property::new("role".to_string(), false, "String".to_string(), true, false, None, None)),
    vec!(),
    EndpointsFilter::all()
);

assert_eq!("User", t.name());

pub fn endpoints(&self) -> &EndpointsFilter

Returns the EndpointsFilter struct associate with this type, determining which CRUD operations should be auto-generated for this node type.

Examples

let t = Type::new(
    "User".to_string(),
    vec!(Property::new("name".to_string(), false, "String".to_string(), true, false, None, None),
         Property::new("role".to_string(), false, "String".to_string(), true, false, None, None)),
    vec!(),
    EndpointsFilter::all()
);

assert_eq!(&EndpointsFilter::all(), t.endpoints());

pub fn props(&self) -> Iter<'_, Property>

Returns an iterator over the Property structs defining properties on this node type.

Examples

let t = Type::new(
    "User".to_string(),
    vec!(Property::new("name".to_string(), false, "String".to_string(), true, false, None, None)),
    vec!(),
    EndpointsFilter::all()
);

assert_eq!("name", t.props().next().expect("Expected property").name());

pub fn props_as_slice(&self) -> &[Property]

Returns a slice of the Property structs defining properties on this node type.

Examples

let t = Type::new(
    "User".to_string(),
    vec!(Property::new("name".to_string(), false, "String".to_string(), true, false, None, None)),
    vec!(),
    EndpointsFilter::all()
);

assert_eq!("name", t.props_as_slice()[0].name());

pub fn rels(&self) -> Iter<'_, Relationship>

Returns an iterator over the Relationship structs defining relationships originating from this node type.

Examples

let t = Type::new(
    "User".to_string(),
    vec!(Property::new("name".to_string(), false, "String".to_string(), true, false, None, None)),
    vec!(Relationship::new("rel_name".to_string(), false, vec!("Role".to_string()), vec!(
        Property::new("rel_prop".to_string(), false, "String".to_string(), true, false, None, None)
    ), EndpointsFilter::all(), None)),
    EndpointsFilter::all()
);

assert_eq!("rel_name", t.rels().next().expect("Expected relationship").name());

Trait Implementations

impl Clone for Type

pub fn clone(&self) -> Type

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Type

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Type

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

Deserialize this value from the given Serde deserializer.

impl Eq for Type

impl Hash for Type

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub 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 Type

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Type> for Type

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

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

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

This method tests for !=.

impl PartialOrd<Type> for Type

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

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

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

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

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

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

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

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

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

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

impl Serialize for Type

pub 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 Type

impl StructuralPartialEq for Type

impl TryFrom<&'_ str> for Type

type Error = Error

The type returned in the event of a conversion error.

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

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

Errors

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

Examples

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

use std::convert::TryFrom;
let t = Type::try_from("
name: User
props:
  - name: name
    type: String
").unwrap();