Struct hotdrink_rs::model::Constraint

pub struct Constraint<T> { /* fields omitted */ }

Represents a constraint in a multiway dataflow constraint system. It has a name, a set of variables it references, a set of Methods to enforce it, and an optional assertion to run to ensure that it is actually enforced upon running a method.

Implementations

impl<T> Constraint<T>

pub fn new_empty(name: String) -> Self

Constructs a new Constraint with no methods.

pub fn new_with_name(name: String, methods: Vec<Method<T>>) -> Self

Constructs a new Constraint with the specified name.

pub fn new_with_name_and_assert(
    name: String,
    methods: Vec<Method<T>>,
    assert: Option<Arc<dyn Fn(&[T]) -> bool>>
) -> Self

Constructs a new Component with the specified name and assertion.

pub fn set_active(&mut self, active: bool)

Enables or disables the constraint.

This decides if the constraint should be enforced during planning.

Trait Implementations

impl<T> Clone for Constraint<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> ConstraintSpec for Constraint<T>

type Method = Method<T>

The type of the methods of the constraint.

fn new(methods: Vec<Self::Method>) -> Self

Constructs a new constraint with the provided methods.

fn name(&self) -> &str

Returns a reference to the name of the constraint.

fn methods(&self) -> &[Self::Method]

Returns a slice to the methods of the constraint.

fn add_method(&mut self, m: Method<T>)

Adds a new method to the constraint.

fn remove_method(&mut self, name: &str)

Remove a method from the constraint system.

Panics

Panics if the method does not exit, or if the name is ambiguous.

fn variables(&self) -> &[usize]

Returns a slice to the variables used by the methods of the constraint.

fn is_active(&self) -> bool

Whether or not this constraint is active.

impl<T> Debug for Constraint<T> where
    T: Debug, 

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

Formats the value using the given formatter.

impl<T> Index<&'_ str> for Constraint<T>

type Output = Method<T>

The returned type after indexing.

fn index(&self, index: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> PartialEq<Constraint<T>> for Constraint<T>

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

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

#[must_use]

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

This method tests for !=.