Struct warpgrapher::engine::config::Relationship

source · [−]

pub struct Relationship { /* private fields */ }

Expand description

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

source

impl Relationship

source

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);

source

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());

source

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());

source

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());

source

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"));

source

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())

source

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())