Struct warpgrapher::engine::config::UsesFilter

pub struct UsesFilter { /* private fields */ }

Configuration item for property usage filters. This allows configuration to control which of the basic creation input, query input, update input, and output uses are auto-generated for a Property. If a filter boolean is set to true, the use of the property is generated. False indicates that the property should be omitted from use. For example, one might set the output use to true and all other uses to false for calculated value that is derived upon request but would never appear in the creation or update of a node. If all are set to false, the property is hidden, meaning that it can be read from and written to the database but does not appear in the client-facing GraphQL schema.

Examples

let uf = UsesFilter::new(true, true, true, true);

Implementations

impl UsesFilter

pub fn new(create: bool, query: bool, update: bool, output: bool) -> UsesFilter

Creates a new filter with the option to configure uses of a property

Examples

let uf = UsesFilter::new(false, false, false, true);

pub fn all() -> UsesFilter

Creates a new filter with all uses – create, query, update, and output

Examples

let uf = UsesFilter::all();

pub fn create(self) -> bool

Returns true if Warpgrapher should use the property in the NodeCreateMutationInput

Examples

let uf = UsesFilter::all();
assert_eq!(true, uf.create());

pub fn query(self) -> bool

Returns true if Warpgrapher should use the property in the NodeQueryInput

Examples

let uf = UsesFilter::all();
assert_eq!(true, uf.query());

pub fn none() -> UsesFilter

Creates a new filter with no uses of a property, hiding it from the GraphQL schema

Examples

let uf = UsesFilter::none();

pub fn output(self) -> bool

Returns true if Warpgrapher should generate a property in the output shape of a node

Examples

let uf = UsesFilter::all();
assert_eq!(true, uf.output());

pub fn update(self) -> bool

Returns true if Warpgrapher should use the property in the NodeUpdateInput

Examples

let uf = UsesFilter::all();
assert_eq!(true, uf.update());

Trait Implementations

impl Clone for UsesFilter

fn clone(&self) -> UsesFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UsesFilter

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

Formats the value using the given formatter.

impl Default for UsesFilter

fn default() -> UsesFilter

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for UsesFilter

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

Deserialize this value from the given Serde deserializer.

impl Hash for UsesFilter

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 UsesFilter

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

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

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

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

This method tests for !=.

impl PartialOrd<UsesFilter> for UsesFilter

fn partial_cmp(&self, other: &UsesFilter) -> 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 UsesFilter

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

Serialize this value into the given Serde serializer.

impl Copy for UsesFilter

impl Eq for UsesFilter

impl StructuralEq for UsesFilter

impl StructuralPartialEq for UsesFilter