Struct Approvers 

pub struct Approvers { /* private fields */ }

The approvers an approval gate requires.

The workflow handler computes them in plain Rust, from its typed input and the outputs of earlier steps, and passes them to ApprovalConfig::requiring. The engine records them on the gate as an ApprovalRequirement when it opens; that record stays the source of truth on replay and resume.

Deserialization rejects zero approvers and a blank group name.

Examples

use ironflow_engine::config::Approvers;

let amount = 15_000;
let approvers = match amount {
    a if a > 100_000 => Approvers::at_least(3)
        .from_groups(["finance", "board"])
        .because("amount > 100k"),
    a if a > 10_000 => Approvers::at_least(2)
        .from_groups(["finance"])
        .because("amount > 10k"),
    _ => Approvers::any(),
};

assert_eq!(approvers.required(), 2);
assert_eq!(approvers.groups(), ["finance".to_string()]);
assert_eq!(approvers.reason(), Some("amount > 10k"));

Implementations

impl Approvers

pub fn any() -> Self

One approval, from anyone allowed to answer the gate.

Examples

use ironflow_engine::config::Approvers;

let approvers = Approvers::any();
assert_eq!(approvers.required(), 1);
assert!(approvers.groups().is_empty());
assert_eq!(approvers.reason(), None);

pub fn at_least(count: u32) -> Self

At least count distinct approvals.

Panics

Panics if count is zero: a gate nobody has to approve is not a gate.

Examples

use ironflow_engine::config::Approvers;

assert_eq!(Approvers::at_least(3).required(), 3);

use ironflow_engine::config::Approvers;

let _ = Approvers::at_least(0);

pub fn from_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::Approvers;

let approvers = Approvers::at_least(2).from_groups([" finance ", "legal", "finance"]);
assert_eq!(approvers.groups(), ["finance".to_string(), "legal".to_string()]);

pub fn because(self, reason: &str) -> Self

Record why these approvers are required.

The reason is an audit label shown on the dashboard and carried by the approval events. It is never evaluated.

Examples

use ironflow_engine::config::Approvers;

let approvers = Approvers::at_least(2).because("amount > 10k");
assert_eq!(approvers.reason(), Some("amount > 10k"));

pub fn required(&self) -> u32

Number of distinct approvals the gate needs.

Examples

use ironflow_engine::config::Approvers;

assert_eq!(Approvers::any().required(), 1);

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

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

Examples

use ironflow_engine::config::Approvers;

assert!(Approvers::at_least(2).groups().is_empty());

pub fn reason(&self) -> Option<&str>

Why these approvers are required, if the handler said so.

Examples

use ironflow_engine::config::Approvers;

assert_eq!(Approvers::any().because("routine").reason(), Some("routine"));

pub fn to_requirement(&self) -> ApprovalRequirement

The requirement the engine records on the gate.

Examples

use ironflow_engine::config::{ApprovalRequirement, Approvers};

let requirement = Approvers::at_least(2).from_groups(["finance"]).to_requirement();
assert_eq!(requirement.required_approvers, 2);
assert_eq!(requirement.approver_groups, vec!["finance".to_string()]);
assert_eq!(Approvers::any().to_requirement(), ApprovalRequirement::default());

Trait Implementations

impl Clone for Approvers

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Approvers

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

Formats the value using the given formatter.

impl Default for Approvers

fn default() -> Self

Same as Approvers::any.

impl<'de> Deserialize<'de> for Approvers

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Approvers

impl PartialEq for Approvers

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Approvers

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 Approvers