battler 0.9.1

Pokémon battle engine for Rust.
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

use alloc::string::{
    String,
    ToString,
};
use core::fmt::Display;

use anyhow::Error;
use thiserror::Error;

use crate::error::WrapError;

/// A general error, consisting of only a message.
#[derive(Error, Debug)]
#[error("{message}")]
pub struct GeneralError {
    message: String,
}

impl GeneralError {
    /// Constructs a new general error.
    pub fn new<M>(message: M) -> Self
    where
        M: Display,
    {
        Self {
            message: message.to_string(),
        }
    }
}

/// A not found error.
#[derive(Error, Debug)]
#[error("{target} not found")]
pub struct NotFoundError {
    target: String,
}

impl NotFoundError {
    /// Constructs a new not found error.
    pub fn new<M>(target: M) -> Self
    where
        M: Display,
    {
        Self {
            target: target.to_string(),
        }
    }
}

/// A borrow failure.
#[derive(Error, Debug)]
#[error("failed to borrow {target}")]
pub struct BorrowFailedError {
    #[source]
    error: anyhow::Error,
    target: String,
}

impl BorrowFailedError {
    /// Constructs a new borrow failure.
    pub fn new<E, M>(error: E, target: M) -> Self
    where
        E: Into<anyhow::Error>,
        M: Display,
    {
        Self {
            error: error.into(),
            target: target.to_string(),
        }
    }
}

/// An integer overflow error.
#[derive(Error, Debug)]
#[error("integer overflow")]
pub struct IntegerOverflowError {
    #[source]
    error: anyhow::Error,
}

impl IntegerOverflowError {
    pub fn wrap(error: anyhow::Error) -> Self {
        Self { error }
    }
}

/// Helper for an [`struct@Error`] wrapping a [`GeneralError`].
#[track_caller]
pub fn general_error<M>(message: M) -> Error
where
    M: Display,
{
    GeneralError::new(message).wrap_error()
}

/// Helper for an [`struct@Error`] wrapping a [`NotFoundError`].
#[track_caller]
pub fn not_found_error<M>(target: M) -> Error
where
    M: Display,
{
    NotFoundError::new(target).wrap_error()
}

/// Helper for an [`struct@Error`] wrapping a [`BorrowFailedError`].
#[track_caller]
pub fn borrow_failed_error<E, M>(error: E, target: M) -> Error
where
    E: Into<anyhow::Error>,
    M: Display,
{
    BorrowFailedError::new(error, target).wrap_error()
}

/// Helper for an [`struct@Error`] wrapping an [`IntegerOverflowError`].
#[track_caller]
pub fn integer_overflow_error<E>(error: E) -> Error
where
    E: Into<anyhow::Error>,
{
    IntegerOverflowError::wrap(error.into()).wrap_error()
}