Struct WaitHuman 

pub struct WaitHuman { /* private fields */ }

Main WaitHuman client for making requests

Implementations

impl WaitHuman

pub fn new_from_key<S: Into<String>>(api_key: S) -> Result<Self>

Creates a new WaitHuman client from just an API key

This is a convenience wrapper around WaitHuman::new() that uses the default endpoint.

Arguments

• api_key - Your WaitHuman API key

Errors

Returns an error if the API key is empty

Example

use wait_human::WaitHuman;

let client = WaitHuman::new_from_key("your-api-key")?;

Examples found in repository

examples/demo.rs (line 6)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let wait_human =
        WaitHuman::new_from_key("sk_3a3b8e8e4bdfd121288cb995d41361042337ef6cada0e48d")?;

    // Example: Multiple Choice Question
    let answer = wait_human
        .ask_multiple_choice(
            "Send invoice?",
            ["yes, send", "no"],
            Some("Customer asked for a 3-page website. is 500$ ok?"),
            None,
        )
        .await?;

    if answer == "yes, send" {
        println!("Send!");
    } else {
        println!("wait...");
    }

    // Example: Free Text
    let feedback = wait_human
        .ask_free_text(
            "User Feedback",
            Some("Please explain why you rejected the invoice."),
            None,
        )
        .await?;

    println!("{}", feedback);

    Ok(())
}

pub fn new(config: WaitHumanConfig) -> Result<Self>

Creates a new WaitHuman client

Arguments

• config - Configuration containing API key and optional endpoint

Errors

Returns an error if the API key is empty

pub async fn ask( &self, question: ConfirmationQuestion, options: Option<AskOptions>, ) -> Result<ConfirmationAnswerWithDate>

General method to ask a question and wait for an answer

Arguments

• question - The confirmation question to ask
• options - Optional settings like timeout

Errors

Returns an error if:

• The confirmation cannot be created
• Network errors occur
• The request times out
• Polling fails

pub async fn ask_free_text<S, B>( &self, subject: S, body: Option<B>, options: Option<AskOptions>, ) -> Result<String>

where S: Into<String>, B: Into<String>,

Convenience method for free-text questions

Arguments

• subject - The question subject/title
• body - Optional detailed question body
• options - Optional settings like timeout

Errors

Returns an error if:

• The request fails or times out
• The answer type doesn’t match (not free text)

Examples found in repository

examples/demo.rs (lines 26-30)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let wait_human =
        WaitHuman::new_from_key("sk_3a3b8e8e4bdfd121288cb995d41361042337ef6cada0e48d")?;

    // Example: Multiple Choice Question
    let answer = wait_human
        .ask_multiple_choice(
            "Send invoice?",
            ["yes, send", "no"],
            Some("Customer asked for a 3-page website. is 500$ ok?"),
            None,
        )
        .await?;

    if answer == "yes, send" {
        println!("Send!");
    } else {
        println!("wait...");
    }

    // Example: Free Text
    let feedback = wait_human
        .ask_free_text(
            "User Feedback",
            Some("Please explain why you rejected the invoice."),
            None,
        )
        .await?;

    println!("{}", feedback);

    Ok(())
}

pub async fn ask_multiple_choice<S, B, C>( &self, subject: S, choices: C, body: Option<B>, options: Option<AskOptions>, ) -> Result<String>

where S: Into<String>, B: Into<String>, C: IntoIterator, C::Item: Into<String>,

Convenience method for multiple-choice questions (single selection)

Arguments

• subject - The question subject/title
• choices - Available choices for the user to select from
• body - Optional detailed question body
• options - Optional settings like timeout

Errors

Returns an error if:

• The request fails or times out
• The answer type doesn’t match (not options)
• The selected index is invalid

Examples found in repository

examples/demo.rs (lines 10-15)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let wait_human =
        WaitHuman::new_from_key("sk_3a3b8e8e4bdfd121288cb995d41361042337ef6cada0e48d")?;

    // Example: Multiple Choice Question
    let answer = wait_human
        .ask_multiple_choice(
            "Send invoice?",
            ["yes, send", "no"],
            Some("Customer asked for a 3-page website. is 500$ ok?"),
            None,
        )
        .await?;

    if answer == "yes, send" {
        println!("Send!");
    } else {
        println!("wait...");
    }

    // Example: Free Text
    let feedback = wait_human
        .ask_free_text(
            "User Feedback",
            Some("Please explain why you rejected the invoice."),
            None,
        )
        .await?;

    println!("{}", feedback);

    Ok(())
}

Trait Implementations

impl Clone for WaitHuman

fn clone(&self) -> WaitHuman

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for WaitHuman

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

Formats the value using the given formatter.