Struct ApprovalConfig 

pub struct ApprovalConfig { /* private fields */ }

Configuration for a human approval step.

When the workflow reaches an approval step, the run transitions to AwaitingApproval and waits for a human to approve or reject via the API.

Examples

use ironflow_engine::config::ApprovalConfig;

let config = ApprovalConfig::new("Deploy to production?");
assert_eq!(config.message(), "Deploy to production?");
assert!(config.timeout_seconds().is_none());

Implementations

impl ApprovalConfig

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

Create a new approval config with the given message.

Examples

use ironflow_engine::config::ApprovalConfig;

let config = ApprovalConfig::new("Approve this deployment?");
assert_eq!(config.message(), "Approve this deployment?");

pub fn with_timeout_seconds(self, seconds: u64) -> Self

Set an auto-reject timeout in seconds.

If no approval or rejection is received within this duration, the run is automatically rejected (marked as Failed).

Examples

use ironflow_engine::config::ApprovalConfig;

let config = ApprovalConfig::new("Approve?")
    .with_timeout_seconds(3600);
assert_eq!(config.timeout_seconds(), Some(3600));

pub fn message(&self) -> &str

The approval message displayed to reviewers.

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

Optional auto-reject timeout in seconds.

Trait Implementations

impl Clone for ApprovalConfig

fn clone(&self) -> ApprovalConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApprovalConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApprovalConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ApprovalConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.