Struct warpgrapher::engine::config::Type [−][src]
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
[src]
pub fn new(
name: String,
props: Vec<Property>,
rels: Vec<Relationship>,
endpoints: EndpointsFilter
) -> Type
[src]
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
[src]
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
[src]
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>
[src]
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 mut_props(&mut self) -> &mut Vec<Property>
[src]
pub fn props_as_slice(&self) -> &[Property]
[src]
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>
[src]
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
[src]
impl Debug for Type
[src]
impl<'de> Deserialize<'de> for Type
[src]
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
[src]
__D: Deserializer<'de>,
impl Eq for Type
[src]
impl Hash for Type
[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 Type
[src]
fn cmp(&self, other: &Type) -> 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<Type> for Type
[src]
impl PartialOrd<Type> for Type
[src]
fn partial_cmp(&self, other: &Type) -> 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 Type
[src]
fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
__S: Serializer,
[src]
__S: Serializer,
impl StructuralEq for Type
[src]
impl StructuralPartialEq for Type
[src]
impl TryFrom<&'_ str> for Type
[src]
type Error = Error
The type returned in the event of a conversion error.
fn try_from(yaml: &str) -> Result<Type, Error>
[src]
Creates a new Type 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::{Type}; use std::convert::TryFrom; let t = Type::try_from(" name: User props: - name: name type: String ").unwrap();
Auto Trait Implementations
impl RefUnwindSafe for Type
impl Send for Type
impl Sync for Type
impl Unpin for Type
impl UnwindSafe for Type
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>,