pub struct Property { /* private fields */ }
Expand description
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
sourceimpl Property
impl Property
sourcepub fn new(
name: String,
uses: UsesFilter,
type_name: String,
required: bool,
list: bool,
resolver: Option<String>,
validator: Option<String>
) -> 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);
sourcepub fn list(&self) -> bool
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());
sourcepub fn name(&self) -> &str
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());
sourcepub fn uses(&self) -> UsesFilter
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());
sourcepub fn resolver(&self) -> Option<&String>
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());
sourcepub fn required(&self) -> bool
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());
sourcepub fn type_name(&self) -> &str
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());
sourcepub fn validator(&self) -> Option<&String>
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
sourceimpl<'de> Deserialize<'de> for Property
impl<'de> Deserialize<'de> for Property
sourcefn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl Ord for Property
impl Ord for Property
sourceimpl PartialOrd<Property> for Property
impl PartialOrd<Property> for Property
sourcefn partial_cmp(&self, other: &Property) -> Option<Ordering>
fn partial_cmp(&self, other: &Property) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
1.0.0 · sourcefn lt(&self, other: &Rhs) -> bool
fn lt(&self, other: &Rhs) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
1.0.0 · sourcefn le(&self, other: &Rhs) -> bool
fn le(&self, other: &Rhs) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
impl Eq for Property
impl StructuralEq for Property
impl StructuralPartialEq for Property
Auto Trait Implementations
impl RefUnwindSafe for Property
impl Send for Property
impl Sync for Property
impl Unpin for Property
impl UnwindSafe for Property
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcepub fn borrow_mut(&mut self) -> &mut T
pub fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
impl<Q, K> Equivalent<K> for Q where
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,
sourcepub fn equivalent(&self, key: &K) -> bool
pub fn equivalent(&self, key: &K) -> bool
Compare self to key
and return true
if they are equal.
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> ToOwned for T where
T: Clone,
impl<T> ToOwned for T where
T: Clone,
type Owned = T
type Owned = T
The resulting type after obtaining ownership.
sourcepub fn to_owned(&self) -> T
pub fn to_owned(&self) -> T
Creates owned data from borrowed data, usually by cloning. Read more
sourcepub fn clone_into(&self, target: &mut T)
pub fn clone_into(&self, target: &mut T)
toowned_clone_into
)Uses borrowed data to replace owned data, usually by cloning. Read more
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
pub fn vzip(self) -> V
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more