Struct WizardBuilder 

pub struct WizardBuilder<T: Wizard> { /* private fields */ }

Builder for configuring and executing a wizard

Implementations

impl<T: Wizard> WizardBuilder<T>

pub fn new() -> Self

Create a new wizard builder

pub fn with_defaults(self, defaults: T) -> Self

Set default values for the wizard

Examples found in repository

examples/defaults_demo.rs (line 23)

fn main() {
    println!("=== Creating a new user profile ===");
    let profile = UserProfile::wizard_builder().build();
    println!("Created profile: {profile:#?}\n");

    println!("=== Editing the existing profile ===");
    println!("The current values will be pre-filled as defaults.");
    let updated_profile = UserProfile::wizard_builder().with_defaults(profile).build();
    println!("Updated profile: {updated_profile:#?}");
}

examples/builder_api.rs (line 42)

fn main() {
    println!("=== Builder API Demo ===\n");

    // Example 1: Simple builder with default backend
    println!("Example 1: Using default backend");
    let config1 = ServerConfig::wizard_builder().build();
    println!("Config: {:#?}\n", config1);

    // Example 2: Builder with custom backend (dialoguer)
    #[cfg(feature = "dialoguer-backend")]
    {
        println!("Example 2: Using dialoguer backend");
        let backend = derive_wizard::DialoguerBackend::new();
        let config2 = ServerConfig::builder().with_backend(backend).build();
        println!("Config: {:#?}\n", config2);
    }

    // Example 3: Builder with defaults
    println!("Example 3: Using defaults (re-prompting with existing values)");
    let defaults = ServerConfig {
        host: "localhost".to_string(),
        port: 8080,
        ssl: true,
    };
    let config3 = ServerConfig::wizard_builder()
        .with_defaults(defaults)
        .build();
    println!("Config: {:#?}\n", config3);
}

examples/builder_comprehensive.rs (line 64)

fn main() {
    println!("=== Comprehensive Builder API Demo ===\n");

    // Example 1: Default usage (uses requestty backend by default)
    #[cfg(feature = "requestty-backend")]
    {
        println!("--- Example 1: Default Builder (Requestty) ---");
        let profile1 = UserProfile::wizard_builder().build();
        println!("Profile: {:#?}\n", profile1);
    }

    // Example 2: With dialoguer backend
    #[cfg(feature = "dialoguer-backend")]
    {
        println!("--- Example 2: Builder with Dialoguer Backend ---");
        let backend = derive_wizard::DialoguerBackend::new();
        let profile2 = UserProfile::builder().with_backend(backend).build();
        println!("Profile: {:#?}\n", profile2);
    }

    // Example 3: With egui backend
    #[cfg(feature = "egui-backend")]
    {
        println!("--- Example 3: Builder with Egui Backend ---");
        let backend = derive_wizard::EguiBackend::new()
            .with_title("User Profile")
            .with_window_size([450.0, 350.0]);

        let profile3 = UserProfile::builder().with_backend(backend).build();
        println!("Profile: {:#?}\n", profile3);
    }

    // Example 4: With defaults (will be prompted with these as starting values)
    #[cfg(feature = "requestty-backend")]
    {
        println!("--- Example 4: Builder with Default Values ---");
        let defaults = UserProfile {
            name: "John Doe".to_string(),
            age: 30,
            email: "john@example.com".to_string(),
            subscribe: true,
        };

        let profile4 = UserProfile::wizard_builder()
            .with_defaults(defaults)
            .build();
        println!("Profile: {:#?}\n", profile4);
    }

    // Example 5: Combining defaults with custom backend
    #[cfg(all(feature = "requestty-backend", feature = "dialoguer-backend"))]
    {
        println!("--- Example 5: Builder with Defaults AND Custom Backend ---");
        let defaults = UserProfile {
            name: "Jane Smith".to_string(),
            age: 25,
            email: "jane@example.com".to_string(),
            subscribe: false,
        };

        let backend = derive_wizard::DialoguerBackend::new();

        let profile5 = UserProfile::builder()
            .with_defaults(defaults)
            .with_backend(backend)
            .build();
        println!("Profile: {:#?}\n", profile5);
    }

    println!("=== Demo Complete ===");
}

pub fn with_backend<B: InterviewBackend + 'static>(self, backend: B) -> Self

Set a custom backend

pub fn build(self) -> T

Execute the wizard and return the result

Examples found in repository

examples/nested_wizard.rs (line 43)

fn main() {
    let user = User::wizard_builder().build();
    println!("{user:#?}");
}

examples/deeply_nested.rs (line 40)

fn main() {
    let event = Event::wizard_builder().build();
    println!("{event:#?}");
}

examples/nested_enum_payment.rs (line 40)

fn main() {
    let order = Order::wizard_builder().build();
    println!("{:#?}", order);
}

examples/validation.rs (line 66)

fn main() {
    let config = ServerConfig::wizard_builder().build();
    println!("{config:#?}");
}

examples/enum_gender.rs (line 51)

fn main() {
    let magic = ShowCase::wizard_builder().build();
    println!("Config: {magic:#?}");
}

examples/showcase.rs (line 54)

fn main() {
    let magic = ShowCase::wizard_builder().build();
    println!("Config: {magic:#?}");
}

Additional examples can be found in:

• examples/password_masking.rs
• examples/enum_transport.rs
• examples/pathbuf_example.rs
• examples/editor.rs
• examples/defaults_demo.rs
• examples/builder_api.rs
• examples/builder_comprehensive.rs

Trait Implementations

impl<T: Default + Wizard> Default for WizardBuilder<T>

fn default() -> WizardBuilder<T>

Returns the “default value” for a type.