Struct warpgrapher::engine::config::EndpointsFilter

pub struct EndpointsFilter { /* fields omitted */ }

Configuration item for endpoint filters. This allows configuration to control which of the basic create, read, update, and delete (CRUD) operations are auto-generated for a Type or a Relationship. If a filter boolean is set to true, the operation is generated. False indicates that the operation should not be generated.

Examples

let ef = EndpointsFilter::new(true, true, true, true);

Implementations

impl EndpointsFilter

pub fn new(
    read: bool,
    create: bool,
    update: bool,
    delete: bool
) -> EndpointsFilter

Creates a new filter with the option to configure all endpoints

Examples

let ef = EndpointsFilter::new(true, true, false, false);

pub fn all() -> EndpointsFilter

Creates a new filter with all endpoints -- create, read, update, and delete

Examples

let ef = EndpointsFilter::all();

pub fn create(self) -> bool

Returns true if Warpgrapher should generate a create operation for the relationship

Examples

let ef = EndpointsFilter::all();
assert_eq!(true, ef.create());

pub fn delete(self) -> bool

Returns true if Warpgrapher should generate a delete operation for the relationship

Examples

let ef = EndpointsFilter::all();
assert_eq!(true, ef.delete());

pub fn none() -> EndpointsFilter

Creates a new filter with all endpoints -- create, read, update, and delete -- filtered out

Examples

let ef = EndpointsFilter::none();

pub fn read(self) -> bool

Returns true if Warpgrapher should generate a read operation for the relationship

Examples

let ef = EndpointsFilter::all();
assert_eq!(true, ef.read());

pub fn update(self) -> bool

Returns true if Warpgrapher should generate a update operation for the relationship

Examples

let ef = EndpointsFilter::all();
assert_eq!(true, ef.update());

Trait Implementations

impl Clone for EndpointsFilter

fn clone(&self) -> EndpointsFilter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for EndpointsFilter

impl Debug for EndpointsFilter

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

Formats the value using the given formatter.

impl Default for EndpointsFilter

fn default() -> EndpointsFilter

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for EndpointsFilter

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

Deserialize this value from the given Serde deserializer.

impl Eq for EndpointsFilter

impl Hash for EndpointsFilter

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 EndpointsFilter

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

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

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

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

This method tests for !=.

impl PartialOrd<EndpointsFilter> for EndpointsFilter

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

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

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

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

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

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

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

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

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

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

impl Serialize for EndpointsFilter

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 EndpointsFilter

impl StructuralPartialEq for EndpointsFilter