Skip to main content

Crate zenquirer

Crate zenquirer 

Source
Expand description

Zenquirer - Interactive command-line questionnaires and prompts

This is the umbrella crate that provides a unified API by re-exporting from zenquirer-core and zenquirer-crossterm.

§Quick Start

use zenquirer::*;

fn main() -> Result<(), zenquirer::Error> {
    zenquirer::smol::block_on(async {
        let backend = CrosstermBackend::new()?;
        let survey = QuestionnaireBuilder::new()
            .input("name", "What's your name?")
            .build();
        let answers = survey.ask_all_async(backend, None).await?;
        Ok(())
    })
}

Note: Zenquirer re-exports smol for convenience, so you don’t need to add it as a separate dependency in your Cargo.toml.

Re-exports§

pub use serde_json;
pub use serde_yaml;
pub use smol;

Modules§

answer
Answer types and value storage.
common
Common utilities for async operations.
macros
Zenquirer Macros
mock
Mock backend for testing questionnaires without terminal I/O.
questionnaire
Questionnaire type and execution traits.
scope
Scoped async questionnaire execution with fluent builder API.
traits
Trait definitions for backend implementations.
types
Core types for questions, answers, and validation.
utils

Macros§

answers
Macro for creating answer collections with clean syntax
question
Macro for creating individual questions with clean syntax

Structs§

Answers
Collection of named answers from a questionnaire.
AsyncScope
Closure-based async scope for clean async questionnaire execution
AsyncValidator
BackendConfig
Configuration for backend behavior and appearance
ColorPalette
Serializable color palette for terminal prompt elements.
ColorPaletteOverrides
Optional color overrides for a ColorPalette.
Confirm
ConfirmBuilder
Builder for creating confirm (yes/no) prompts.
CrosstermBackend
Crossterm based backend using smol async runtime
Date
DateBuilder
Builder for creating date input prompts (YYYY-MM-DD format).
DateTime
DateTimeBuilder
Builder for creating datetime input prompts (YYYY-MM-DD HH:MM:SS format).
Editor
EditorBuilder
Builder for creating external editor prompts.
FilePicker
FilePicker prompt struct for selecting files and directories
FilePickerBuilder
Builder for creating interactive file/directory picker prompts.
Input
InputBuilder
Builder for creating text input prompts.
IntegerBuilder
Builder for integer prompts.
MultiSelect
MultiSelectBuilder
Builder for creating multiselect (multiple-choice) prompts.
NumberBuilder
Builder for creating numeric input prompts.
Password
PasswordBuilder
Builder for creating password input prompts.
QuestionAnswer
A single question-answer pair.
QuestionData
Serializable question configuration.
QuestionOption
Serializable option wrapper for select/multiselect questions.
Questionnaire
Collection of questions forming a questionnaire.
QuestionnaireBuilder
Builder for creating questionnaires with a fluent API
QuestionnaireScope
The execution scope for a questionnaire that manages state and backend (sync version)
ScopeConfirmBuilder
Builder for confirm questions within a scope
ScopeInputBuilder
Builder for text input questions within a scope
ScopeMultiSelectBuilder
Builder for multi-select questions within a scope
ScopeNumberBuilder
Builder for number input questions within a scope
ScopeSelectBuilder
Builder for select questions within a scope
ScopedBuilder
Builder for creating and asking questions within an async scope
ScopedResult
Result of scoped questionnaire execution
Select
SelectBuilder
Builder for creating select (single-choice) prompts.
Validator
Validator with chainable validation rules and custom error messages.

Enums§

Answer
Answer value from a questionnaire question.
ColorScheme
Color scheme for the terminal interface
Error
Error types for Zenquirer operations.
LayoutStyle
Layout style for rendering prompts and answers
Question
QuestionType
Type of question in a questionnaire.
TerminalColor
Serializable terminal color used by crossterm backends.
ValidationRule
Individual validation rules that can be applied to inputs.

Traits§

AllPrompts
Combined trait for backends that support all prompt types
AsyncQuestionnaireScope
Trait for executing questionnaires in a scoped async context.
AutocompletePrompt
Trait for autocomplete input with live search
ConfirmPrompt
Trait for rendering yes/no confirmation prompts.
DatePickerPrompt
Trait for visual calendar date picker
DatePrompt
Trait for date input
DateTimePrompt
Trait for datetime input
EditorPrompt
Trait for rendering multi-line editor prompts.
FilePickerPrompt
Trait for file picker input
InputPrompt
Trait for rendering text input prompts.
LazyMultiSelectPrompt
Trait for lazy-loaded multi-select (loads options asynchronously)
LazySelectPrompt
Trait for lazy-loaded select (loads options asynchronously)
MultiSelectKeyValuePrompt
Trait for multiselect keyvalue prompts.
MultiSelectPrompt
Trait for rendering multi-selection prompts.
NumberPrompt
Trait for rendering numeric input prompts.
PasswordPrompt
Trait for rendering password input prompts.
QuestionnaireExt
Trait for executing questionnaires asynchronously.
QuestionnairePrompt
Trait for complete questionnaire execution with headers/footers
SelectKeyValuePrompt
Trait for select keyvalue prompts.
SelectPrompt
Trait for rendering single-selection prompts.

Functions§

extract_bool
Extract bool value from an option.
extract_f64
Extract f64 value from an option.
extract_i32
Extract i32 value from an option.
extract_string
Extract string value from an option.
filter_options
Filters options based on case-insensitive substring matching

Type Aliases§

OptionValue
Type alias for backward compatibility