[][src]Crate serde_spaniel

Spaniel Interactive Deserialiser

This crate is a Rust library which uses the Serde serialisation framework to capture data interactively from users.

Modules

de

Serde deserialiser.

prompt

Traits and decorators for working with prompts.

rustyline

Prompt based on the RustyLine crate.

ser

Serde serialiser.

stdio

Prompt based on std::io.

Enums

Error

This type represents errors that may occur.

UserAction

This type represents actions a user may take while interacting with the deserialiser.

Functions

from_bare_prompt

Deserialise a value of type T from a prompt using the bare deserialiser.

from_bare_prompt_confirm

Deserialise a value of type T from a prompt using the bare deserialiser followed by confirmation.

from_console

Deserialise an instance of type T from the console.

from_prompt

Deserialise a value of type T from a prompt while handling undos, restarts, meta-commands, and scope compacting.

from_replay_prompt

Deserialise a value of type T from a prompt while handling undos and restarts.

to_bare_prompt

Serialise an instance of type T to a prompt using the bare serialiser.

to_prompt

Serialise an instance of type T to a prompt while handling meta-commands and scope compacting.

Type Definitions

Result