Struct HumanInputConfig 

pub struct HumanInputConfig { /* private fields */ }

Configuration for a typed human input step.

When the workflow reaches a human input step, the run transitions to AwaitingApproval and waits for a human to submit an answer matching the JSON schema of the expected type, or to reject the request, via the API.

The step reuses the approval gate machinery: a deadline, an escalation policy, an assignee and the Approvers allowed to answer. The first valid answer wins; Approvers::at_least only restricts who may answer.

A human input cannot be auto-approved on timeout since there is no value to fill in: on_timeout refuses EscalationPolicy::AutoApprove.

Examples

use std::time::Duration;
use ironflow_engine::config::{EscalationPolicy, HumanInputConfig};

let config = HumanInputConfig::new("Answer the clarification questions")
    .with_deadline(Duration::from_secs(3600))
    .on_timeout(EscalationPolicy::AutoReject);
assert_eq!(config.message(), "Answer the clarification questions");
assert_eq!(config.deadline_secs(), Some(3600));

Implementations

impl HumanInputConfig

pub fn new(message: &str) -> Self

Create a new human input config with the given message.

Examples

use ironflow_engine::config::HumanInputConfig;

let config = HumanInputConfig::new("Which environment?");
assert_eq!(config.message(), "Which environment?");

pub fn with_deadline(self, deadline: Duration) -> Self

Set the SLA deadline of this input.

Sub-second precision is dropped: the deadline is stored in whole seconds.

Panics

Panics if deadline rounds down to zero seconds.

Examples

use std::time::Duration;
use ironflow_engine::config::HumanInputConfig;

let config = HumanInputConfig::new("Answer?").with_deadline(Duration::from_secs(1800));
assert_eq!(config.deadline(), Some(Duration::from_secs(1800)));

pub fn with_deadline_secs(self, secs: u64) -> Self

Set the SLA deadline of this input, in seconds.

Panics

Panics if secs is zero.

Examples

use ironflow_engine::config::HumanInputConfig;

let config = HumanInputConfig::new("Answer?").with_deadline_secs(1800);
assert_eq!(config.deadline_secs(), Some(1800));

pub fn on_timeout(self, policy: EscalationPolicy) -> Self

Set the policy applied when the deadline fires.

Panics

Panics if the policy is EscalationPolicy::AutoApprove or a EscalationPolicy::Chain containing it: a human input has no value to fill in automatically.

Examples

use ironflow_engine::config::{EscalationPolicy, HumanInputConfig};

let config = HumanInputConfig::new("Answer?")
    .with_deadline_secs(3600)
    .on_timeout(EscalationPolicy::AutoReject);
assert_eq!(config.effective_policy(), EscalationPolicy::AutoReject);

use ironflow_engine::config::{EscalationPolicy, HumanInputConfig};

let _ = HumanInputConfig::new("Answer?").on_timeout(EscalationPolicy::AutoApprove);

pub fn assigned_to(self, assignee: Assignee) -> Self

Assign the input to a user or group.

Panics

Panics if the assignee name is empty or only whitespace.

Examples

use ironflow_engine::config::HumanInputConfig;
use ironflow_store::entities::Assignee;

let config = HumanInputConfig::new("Answer?").assigned_to(Assignee::user("alice"));
assert_eq!(config.assignee(), Some(&Assignee::user("alice")));

pub fn requiring(self, approvers: Approvers) -> Self

Restrict who may answer. A later call replaces an earlier one.

The first valid answer resolves the step, whatever the required count.

Examples

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

let config = HumanInputConfig::new("Answer?")
    .requiring(Approvers::any().from_groups(["product"]));
assert!(config.approvers().is_some());

pub fn message(&self) -> &str

The message displayed to the person answering.

Examples

use ironflow_engine::config::HumanInputConfig;

assert_eq!(HumanInputConfig::new("Answer?").message(), "Answer?");

pub fn deadline(&self) -> Option<Duration>

The configured SLA deadline, if any.

Examples

use std::time::Duration;
use ironflow_engine::config::HumanInputConfig;

let config = HumanInputConfig::new("Answer?").with_deadline_secs(60);
assert_eq!(config.deadline(), Some(Duration::from_secs(60)));

pub fn deadline_secs(&self) -> Option<u64>

The configured SLA deadline in seconds, if any.

Examples

use ironflow_engine::config::HumanInputConfig;

assert!(HumanInputConfig::new("Answer?").deadline_secs().is_none());

pub fn on_timeout_policy(&self) -> Option<&EscalationPolicy>

The configured escalation policy, if any.

Examples

use ironflow_engine::config::HumanInputConfig;

assert!(HumanInputConfig::new("Answer?").on_timeout_policy().is_none());

pub fn assignee(&self) -> Option<&Assignee>

The user or group the input is assigned to, if any.

Examples

use ironflow_engine::config::HumanInputConfig;

assert!(HumanInputConfig::new("Answer?").assignee().is_none());

pub fn approvers(&self) -> Option<&Approvers>

The approvers allowed to answer, if any were set.

Examples

use ironflow_engine::config::HumanInputConfig;

assert!(HumanInputConfig::new("Answer?").approvers().is_none());

pub fn effective_deadline_secs(&self) -> Option<u64>

The deadline actually enforced, in seconds.

Examples

use ironflow_engine::config::HumanInputConfig;

let config = HumanInputConfig::new("Answer?").with_deadline_secs(60);
assert_eq!(config.effective_deadline_secs(), Some(60));

pub fn effective_policy(&self) -> EscalationPolicy

The policy applied when the deadline fires. Defaults to EscalationPolicy::AutoReject.

Examples

use ironflow_engine::config::{EscalationPolicy, HumanInputConfig};

let config = HumanInputConfig::new("Answer?").with_deadline_secs(60);
assert_eq!(config.effective_policy(), EscalationPolicy::AutoReject);

Trait Implementations

impl Clone for HumanInputConfig

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 HumanInputConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for HumanInputConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for HumanInputConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.