Struct warpgrapher::engine::config::Property

pub struct Property { /* private fields */ }

Configuration item for a property on a GraphQL type, modeled as properties on a graph node.

Examples

let p = Property::new("name".to_string(), UsesFilter::all(), "String".to_string(), true,
false, None, None);

Implementations

impl Property

pub fn new(
    name: String,
    uses: UsesFilter,
    type_name: String,
    required: bool,
    list: bool,
    resolver: Option<String>,
    validator: Option<String>
) -> Property

Creates a new Property struct.

Arguments

• a String for the name of the property
• a String for the type of the property
• a boolean that, if true, indicatees that the property is mandatory, and if false, that the property is optional
• a boolean that, if true, indicates that the property is a list of scalers, and if false, that the property is a single value
• an optional string providing the name of a resolver, if the property is a dynamic property with a custom resolver, and
• an optional string providing the name of a custom validator

Examples

let p = Property::new("name".to_string(), UsesFilter::all(), "String".to_string(), true,
false, None, None);

pub fn list(&self) -> bool

Returns a boolean that if true, indicates that this property contains a list of scalar values, and if false, indicates that the property contains only one value (or potentially zero values if required is also false).

Examples

use warpgrapher::engine::config::Property;

let p = Property::new(“name”.to_string(), UsesFiter::all(), “String”.to_string(), true, false, None, None);

assert!(!p.list());

pub fn name(&self) -> &str

Returns the name of the property

Examples

use warpgrapher::engine::config::Property;

let p = Property::new(“propname”.to_string(), UsesFilter::all(), “String”.to_string(), true, false, None, None);

assert_eq!(“propname”, p.name());

pub fn uses(&self) -> UsesFilter

Returns the filter describing how a property is to be used

Examples

use warpgrapher::engine::config::Property;

let p = Property::new(“propname”.to_string(), UsesFilter::all(), “String”.to_string(), true, false, None, None);

assert_eq!(UsesFilter::all(), p.uses());

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

Returns the optional name of the custom resolver associated with this property

Examples

use warpgrapher::engine::config::Property;

let p = Property::new(“propname”.to_string(), “String”.to_string(), true, false, Some(“CustomResolver”.to_string()), None);

assert_eq!(“CustomResolver”, p.resolver().unwrap());

pub fn required(&self) -> bool

Returns a boolean that if true, indicates that this property is mandatory, and if false, that the property is not required, and may be absent.

Examples

use warpgrapher::engine::config::Property;

let p = Property::new(“name”.to_string(), “String”.to_string(), true, false, None, None);

assert!(p.required());

pub fn type_name(&self) -> &str

Returns the name of the type of the property

Examples

use warpgrapher::engine::config::Property;

let p = Property::new(“propname”.to_string(), “String”.to_string(), true, false, None, None);

assert_eq!(“String”, p.type_name());

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

Returns the optional name of the custom validator associated with this property

Examples

use warpgrapher::engine::config::Property;

let p = Property::new(“propname”.to_string(), “String”.to_string(), true, false, None, Some(“CustomValidator”.to_string()));

assert_eq!(“CustomValidator”, p.validator().unwrap());

Trait Implementations

impl Clone for Property

fn clone(&self) -> Property

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Property

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Property

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

Deserialize this value from the given Serde deserializer.

impl Hash for Property

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 Property

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<Property> for Property

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

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

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

This method tests for !=.

impl PartialOrd<Property> for Property

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

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

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

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

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

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

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

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

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

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

impl Serialize for Property

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.

impl Eq for Property

impl StructuralEq for Property

impl StructuralPartialEq for Property