Struct warpgrapher::engine::config::Relationship

pub struct Relationship { /* fields omitted */ }

Configuration item for a relationship on a GraphQL type

Examples

let r = Relationship::new(
    "teams".to_string(),
    true,
    vec!["User".to_string()],
    vec![],  
    EndpointsFilter::all(),
    None
);

Implementations

impl Relationship

pub fn new(
    name: String,
    list: bool,
    nodes: Vec<String>,
    props: Vec<Property>,
    endpoints: EndpointsFilter,
    resolver: Option<String>
) -> Relationship

Creates a new Relationship struct.

Arguments

• a String for the name of the relationship
• a boolean that, if true, indicates that the property is a list, and if false, that the relationship is to a single node
• a list of possible destination node types for the relationship. A single element in the list indicates that this is a single-type relationship, whereas more than one element indicates a multi-type relationship.
• an EndpointsFilter struct indicating which of the standard operations (create, read, update, and delete) should be generated for this relationship
• an optional string providing the name of a resolver, if the relationship is a dynamic relationship with a custom resolver

Examples

let r = Relationship::new("name".to_string(), false, vec!["User".to_string()], vec![],
    EndpointsFilter::all(), None);

pub fn endpoints(&self) -> &EndpointsFilter

Returns the EndpointsFilter struct that indicates which of the four basic Create, Read, Update, and Delete (CRUD) operations Warpgrapher should auto-generate for this relationship.

Examples

let r = Relationship::new("name".to_string(), false, vec!["User".to_string()], vec![],
    EndpointsFilter::all(), None);

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

pub fn list(&self) -> bool

Returns true if the relationship is a list, indicating a one-to-many (or many-to-many) relationship. Returns false if the node can only have one relationship of this type.

Examples

let r = Relationship::new("name".to_string(), true, vec!["User".to_string()], vec![],
    EndpointsFilter::all(), None);

assert!(r.list());

pub fn name(&self) -> &str

Returns the name of the relationship

Examples

let r = Relationship::new("RelName".to_string(), true, vec!["User".to_string()], vec![],
    EndpointsFilter::all(), None);

assert_eq!("RelName", r.name());

pub fn nodes(&self) -> Iter<'_, String>

Returns an iterator over the names of the Warpgrapher Type definitions that are possible destination nodes for this relationship.

Examples

let r = Relationship::new("RelName".to_string(), true, vec!["User".to_string()], vec![],
    EndpointsFilter::all(), None);

assert_eq!(1, r.nodes().count());
assert_eq!("User", r.nodes().next().expect("Expected an element"));

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

Returns a slice of Property references for properties associated with the relationship.

Examples

let r = Relationship::new("RelName".to_string(), true, vec!["User".to_string()], vec![],
    EndpointsFilter::all(), None);

assert_eq!(0, r.props_as_slice().len())

pub fn resolver(&self) -> Option<&String>

Returns an option for a string containing the name of a custom resolver, if this relationship is resolved by a custom resolver instead of an auto-generated read resolver.

Examples

let r = Relationship::new("RelName".to_string(), true, vec!["User".to_string()], vec![],
    EndpointsFilter::all(), None);

assert!(r.resolver().is_none())

Trait Implementations

impl Clone for Relationship

fn clone(&self) -> Relationship

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Relationship

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Relationship

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

Deserialize this value from the given Serde deserializer.

impl Eq for Relationship

impl Hash for Relationship

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 Relationship

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

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

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

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

This method tests for !=.

impl PartialOrd<Relationship> for Relationship

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

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

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

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

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

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

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

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

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

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

impl Serialize for Relationship

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 Relationship

impl StructuralPartialEq for Relationship