Struct issue_states::state::IssueState

pub struct IssueState<C>where
    C: Condition + Sized,{
    pub conditions: Vec<C>,
    pub relations: StateRelations<C>,
    /* private fields */
}

Representaiton of an issue state

An issue state is a named transient property depending on an issue’s metadata. For a given issue, a state is either enabled or disabled based on the Conditions attached to state. Additionally, a state may or may not be related to other issues. Those relations affect whether a state is selected by a resolver for a given issue, provided that it is enabled for saif issue.

Fields

conditions: Vec<C>

Metadata conditions of the state

relations: StateRelations<C>

Relations to ther states

Implementations

impl<C> IssueState<C>where
    C: Condition + Sized,

pub fn new(name: String) -> Self

Create an issue state with a given name

pub fn name(&self) -> &String

Retrieve the name of the issue state

pub fn add_extended<I>(&mut self, dependencies: I)where
    I: IntoIterator<Item = Arc<IssueState<C>>>,

Add states on which this state depends on

pub fn add_overridden<I>(&mut self, overridden_by: I)where
    I: IntoIterator<Item = Arc<IssueState<C>>>,

Add states which will override this state

pub fn conditions_satisfied(&self, issue: &C::Issue) -> bool

Check whether all conditions of the state are satisfied for an issue

Note:

Conditions inherited from states extended by this state are not considered. Thus, this function alone can not be used for assessing whether the state is enabled or not.

Trait Implementations

impl<C> Ord for IssueState<C>where
    C: Condition,

fn cmp(&self, other: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere
    Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl<C> PartialEq<IssueState<C>> for IssueState<C>where
    C: Condition,

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

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

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

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

impl<C> PartialOrd<IssueState<C>> for IssueState<C>where
    C: Condition,

fn partial_cmp(&self, other: &Self) -> 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<C> Eq for IssueState<C>where
    C: Condition,