rpg-chat-command-parser 0.1.0

A command line parser for RPG-like chat commands. Processes commands such as '/heal Player1', '/equip sword', or '/party invite Player2', validates their structure, and produces structured output for integration into games.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31

//! # Error Handling for RPG Chat Command Parser
//!
//! This module defines custom errors for the command parser, using the [`thiserror`](https://docs.rs/thiserror) crate.
//!
//! ## Errors
//! - **`InvalidSyntax`**: Indicates a syntax error in the input command.
//! - **`MissingFlagKey`**: A flag is missing its key.
//! - **`MissingFlagValue`**: A flag is missing its value.
//! - **`MissingVerb`**: The command is missing a verb.

use thiserror::Error;

/// Custom error type for command parsing errors.
#[derive(Error, Debug)]
pub enum CommandError {
    /// The command syntax is invalid.
    #[error("Invalid command syntax")]
    InvalidSyntax,

    /// A flag is missing its key.
    #[error("Missing key in flag")]
    MissingFlagKey,

    /// A flag is missing its value.
    #[error("Missing value in flag")]
    MissingFlagValue,

    /// The command is missing a verb.
    #[error("Missing verb in command")]
    MissingVerb,
}