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.
- Async
Scope - Closure-based async scope for clean async questionnaire execution
- Async
Validator - Backend
Config - Configuration for backend behavior and appearance
- Color
Palette - Serializable color palette for terminal prompt elements.
- Color
Palette Overrides - Optional color overrides for a
ColorPalette. - Confirm
- Confirm
Builder - Builder for creating confirm (yes/no) prompts.
- Crossterm
Backend - Crossterm based backend using smol async runtime
- Date
- Date
Builder - Builder for creating date input prompts (YYYY-MM-DD format).
- Date
Time - Date
Time Builder - Builder for creating datetime input prompts (YYYY-MM-DD HH:MM:SS format).
- Editor
- Editor
Builder - Builder for creating external editor prompts.
- File
Picker - FilePicker prompt struct for selecting files and directories
- File
Picker Builder - Builder for creating interactive file/directory picker prompts.
- Input
- Input
Builder - Builder for creating text input prompts.
- Integer
Builder - Builder for integer prompts.
- Multi
Select - Multi
Select Builder - Builder for creating multiselect (multiple-choice) prompts.
- Number
Builder - Builder for creating numeric input prompts.
- Password
- Password
Builder - Builder for creating password input prompts.
- Question
Answer - A single question-answer pair.
- Question
Data - Serializable question configuration.
- Question
Option - Serializable option wrapper for select/multiselect questions.
- Questionnaire
- Collection of questions forming a questionnaire.
- Questionnaire
Builder - Builder for creating questionnaires with a fluent API
- Questionnaire
Scope - The execution scope for a questionnaire that manages state and backend (sync version)
- Scope
Confirm Builder - Builder for confirm questions within a scope
- Scope
Input Builder - Builder for text input questions within a scope
- Scope
Multi Select Builder - Builder for multi-select questions within a scope
- Scope
Number Builder - Builder for number input questions within a scope
- Scope
Select Builder - Builder for select questions within a scope
- Scoped
Builder - Builder for creating and asking questions within an async scope
- Scoped
Result - Result of scoped questionnaire execution
- Select
- Select
Builder - 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.
- Color
Scheme - Color scheme for the terminal interface
- Error
- Error types for Zenquirer operations.
- Layout
Style - Layout style for rendering prompts and answers
- Question
- Question
Type - Type of question in a questionnaire.
- Terminal
Color - Serializable terminal color used by crossterm backends.
- Validation
Rule - Individual validation rules that can be applied to inputs.
Traits§
- AllPrompts
- Combined trait for backends that support all prompt types
- Async
Questionnaire Scope - Trait for executing questionnaires in a scoped async context.
- Autocomplete
Prompt - Trait for autocomplete input with live search
- Confirm
Prompt - Trait for rendering yes/no confirmation prompts.
- Date
Picker Prompt - Trait for visual calendar date picker
- Date
Prompt - Trait for date input
- Date
Time Prompt - Trait for datetime input
- Editor
Prompt - Trait for rendering multi-line editor prompts.
- File
Picker Prompt - Trait for file picker input
- Input
Prompt - Trait for rendering text input prompts.
- Lazy
Multi Select Prompt - Trait for lazy-loaded multi-select (loads options asynchronously)
- Lazy
Select Prompt - Trait for lazy-loaded select (loads options asynchronously)
- Multi
Select KeyValue Prompt - Trait for multiselect keyvalue prompts.
- Multi
Select Prompt - Trait for rendering multi-selection prompts.
- Number
Prompt - Trait for rendering numeric input prompts.
- Password
Prompt - Trait for rendering password input prompts.
- Questionnaire
Ext - Trait for executing questionnaires asynchronously.
- Questionnaire
Prompt - Trait for complete questionnaire execution with headers/footers
- Select
KeyValue Prompt - Trait for select keyvalue prompts.
- Select
Prompt - 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§
- Option
Value - Type alias for backward compatibility