Skip to main content

ApprovalRule

Struct ApprovalRule 

Source
pub struct ApprovalRule { /* private fields */ }
Expand description

A conditional approval requirement.

When an approval gate opens, the rules of its ApprovalConfig are evaluated in order against the run context; the first rule whose condition holds decides how many distinct approvals the gate needs and, optionally, which groups the approvers must belong to. See Expression for the condition syntax.

Deserialization rejects an invalid condition and required_approvers == 0.

§Examples

use ironflow_engine::config::ApprovalRule;
use serde_json::json;

let rule = ApprovalRule::new("payload.amount > 10000", 2).with_approver_groups(["finance"]);
assert_eq!(rule.required_approvers(), 2);
assert_eq!(rule.approver_groups(), ["finance".to_string()]);
assert!(rule.matches(&json!({"payload": {"amount": 15000}})));

Implementations§

Source§

impl ApprovalRule

Source

pub fn new(condition: &str, required_approvers: usize) -> Self

Create a rule from a condition source and a number of approvers.

§Panics

Panics if condition is not a valid Expression or if required_approvers is zero.

§Examples
use ironflow_engine::config::ApprovalRule;

let rule = ApprovalRule::new("labels.env == 'production'", 2);
assert_eq!(rule.condition().source(), "labels.env == 'production'");
Source

pub fn from_expression(condition: Expression, required_approvers: usize) -> Self

Create a rule from an already parsed Expression.

§Panics

Panics if required_approvers is zero.

§Examples
use ironflow_engine::config::ApprovalRule;
use ironflow_engine::expression::Expression;

let rule = ApprovalRule::from_expression(Expression::parse("payload.urgent")?, 3);
assert_eq!(rule.required_approvers(), 3);
Source

pub fn with_approver_groups<I, S>(self, groups: I) -> Self
where I: IntoIterator<Item = S>, S: Into<String>,

Restrict voting to members of the given groups.

Names are trimmed and deduplicated. Admins may always vote.

§Panics

Panics if a group name is empty or only whitespace.

§Examples
use ironflow_engine::config::ApprovalRule;

let rule = ApprovalRule::new("payload.amount > 10000", 2)
    .with_approver_groups([" finance ", "legal", "finance"]);
assert_eq!(rule.approver_groups(), ["finance".to_string(), "legal".to_string()]);
Source

pub fn condition(&self) -> &Expression

The condition deciding whether this rule applies.

§Examples
use ironflow_engine::config::ApprovalRule;

let rule = ApprovalRule::new("payload.urgent", 1);
assert_eq!(rule.condition().to_string(), "payload.urgent");
Source

pub fn required_approvers(&self) -> usize

Number of distinct approvals the gate needs when this rule applies.

§Examples
use ironflow_engine::config::ApprovalRule;

assert_eq!(ApprovalRule::new("payload.urgent", 3).required_approvers(), 3);
Source

pub fn approver_groups(&self) -> &[String]

Groups whose members may vote. Empty means no group restriction.

§Examples
use ironflow_engine::config::ApprovalRule;

assert!(ApprovalRule::new("payload.urgent", 1).approver_groups().is_empty());
Source

pub fn matches(&self, ctx: &Value) -> bool

Whether the condition holds for the given context.

§Examples
use ironflow_engine::config::ApprovalRule;
use serde_json::json;

let rule = ApprovalRule::new("labels.env == 'production'", 2);
assert!(rule.matches(&json!({"labels": {"env": "production"}})));
assert!(!rule.matches(&json!({"labels": {}})));

Trait Implementations§

Source§

impl Clone for ApprovalRule

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ApprovalRule

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ApprovalRule

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ApprovalRule

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl Serialize for ApprovalRule

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ApprovalRule

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more