Struct ContributionConstraint 

pub struct ContributionConstraint {
    pub group: Option<i32>,
    pub id: Option<String>,
    pub inverse: Option<bool>,
    pub name: Option<String>,
    pub properties: Option<Value>,
    pub relationships: Vec<String>,
}

Specifies a constraint that can be used to dynamically include/exclude a given contribution

Fields

group: Option<i32>

An optional property that can be specified to group constraints together. All constraints within a group are AND’d together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR’d (only one group needs to evaluate to True for the contribution to be included).

id: Option<String>

Fully qualified identifier of a shared constraint

inverse: Option<bool>

If true, negate the result of the filter (include the contribution if the applied filter returns false instead of true)

name: Option<String>

Name of the IContributionFilter plugin

properties: Option<Value>

Properties that are fed to the contribution filter class

relationships: Vec<String>

Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.

Implementations

impl ContributionConstraint

pub fn new() -> Self

Trait Implementations

impl Clone for ContributionConstraint

fn clone(&self) -> ContributionConstraint

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ContributionConstraint

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

Formats the value using the given formatter.

impl Default for ContributionConstraint

fn default() -> ContributionConstraint

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContributionConstraint

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ContributionConstraint

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for ContributionConstraint

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ContributionConstraint