Struct Rule 

pub struct Rule {
    pub id: u64,
    pub rows: Vec<Row>,
    pub strength: Strength,
    pub label: String,
    pub source: String,
    pub entities: Vec<u64>,
    pub unsupported: Option<String>,
}

A rule: one or more rows with shared metadata.

Fields

id: u64

Stable rule ID (the document constraint ID or a synthetic ID).

rows: Vec<Row>

Rows.

strength: Strength

Strength.

label: String

Human readable label used in diagnostics ("distance 50 mm").

source: String

Source label ("user", "edit", "plugin:acme.wall", …).

entities: Vec<u64>

Related entity IDs for diagnostics.

unsupported: Option<String>

When set, the rule cannot be expressed; components containing it report unsupported instead of being solved.

Implementations

impl Rule

pub fn new(id: u64, rows: Vec<Row>, strength: Strength) -> Self

Create a rule with default metadata.

pub fn label(self, l: impl Into<String>) -> Self

Builder: label.

pub fn source(self, s: impl Into<String>) -> Self

Builder: source.

pub fn entities(self, e: Vec<u64>) -> Self

Builder: related entities.

pub fn vars(&self) -> Vec<VarId>

Variables referenced by any row.

pub fn is_hard(&self) -> bool

Whether this is a hard rule.

Trait Implementations

impl Clone for Rule

fn clone(&self) -> Rule

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Rule

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Rule

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Rule

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

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 Rule