spinoso_regexp/error.rs
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 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358
use core::fmt;
use std::borrow::Cow;
use std::error;
/// Sum type of all errors possibly returned from `Regexp` APIs.
#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub enum Error {
/// Error that indicates an argument parsing or value logic error occurred.
///
/// See [`ArgumentError`].
Argument(ArgumentError),
/// Error that indicates a `Regexp` was malformed at runtime.
///
/// See [`RegexpError`].
Regexp(RegexpError),
/// Error that indicates a given `Regexp` pattern could not be parsed when
/// given as a `/.../` literal in Ruby source code.
///
/// See [`SyntaxError`].
Syntax(SyntaxError),
}
impl From<ArgumentError> for Error {
#[inline]
fn from(err: ArgumentError) -> Self {
Self::Argument(err)
}
}
impl From<RegexpError> for Error {
#[inline]
fn from(err: RegexpError) -> Self {
Self::Regexp(err)
}
}
impl From<SyntaxError> for Error {
#[inline]
fn from(err: SyntaxError) -> Self {
Self::Syntax(err)
}
}
impl fmt::Display for Error {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str("Regexp error")
}
}
impl error::Error for Error {
#[inline]
fn source(&self) -> Option<&(dyn error::Error + 'static)> {
match self {
Self::Argument(ref err) => Some(err),
Self::Regexp(ref err) => Some(err),
Self::Syntax(ref err) => Some(err),
}
}
}
/// Error that indicates an argument parsing or value logic error occurred.
///
/// Argument errors have an associated message.
///
/// This error corresponds to the [Ruby `ArgumentError` Exception class].
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::ArgumentError;
/// let err = ArgumentError::new();
/// assert_eq!(err.message(), "ArgumentError");
///
/// let err = ArgumentError::with_message("invalid byte sequence in UTF-8");
/// assert_eq!(err.message(), "invalid byte sequence in UTF-8");
/// ```
///
/// [Ruby `ArgumentError` Exception class]: https://ruby-doc.org/core-3.1.2/ArgumentError.html
#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub struct ArgumentError(Cow<'static, str>);
impl From<&'static str> for ArgumentError {
#[inline]
fn from(message: &'static str) -> Self {
Self::with_message(message)
}
}
impl From<String> for ArgumentError {
fn from(message: String) -> Self {
Self(Cow::Owned(message))
}
}
impl Default for ArgumentError {
#[inline]
fn default() -> Self {
Self::new()
}
}
impl fmt::Display for ArgumentError {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(self.message())
}
}
impl error::Error for ArgumentError {}
impl ArgumentError {
/// Construct a new, default argument error.
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::ArgumentError;
/// const ERR: ArgumentError = ArgumentError::new();
/// assert_eq!(ERR.message(), "ArgumentError");
/// ```
#[inline]
#[must_use]
pub const fn new() -> Self {
Self(Cow::Borrowed("ArgumentError"))
}
/// Construct a new argument error with a message.
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::ArgumentError;
/// const ERR: ArgumentError = ArgumentError::with_message("invalid byte sequence in UTF-8");
/// assert_eq!(ERR.message(), "invalid byte sequence in UTF-8");
/// ```
#[inline]
#[must_use]
pub const fn with_message(message: &'static str) -> Self {
Self(Cow::Borrowed(message))
}
#[must_use]
pub(crate) const fn unsupported_pattern_encoding() -> Self {
Self::with_message("Unsupported pattern encoding")
}
#[must_use]
pub(crate) const fn unsupported_haystack_encoding() -> Self {
Self::with_message("Unsupported haystack encoding")
}
/// Retrieve the exception message associated with this argument error.
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::ArgumentError;
/// let err = ArgumentError::new();
/// assert_eq!(err.message(), "ArgumentError");
///
/// let err = ArgumentError::with_message("invalid byte sequence in UTF-8");
/// assert_eq!(err.message(), "invalid byte sequence in UTF-8");
/// ```
#[inline]
#[must_use]
pub fn message(&self) -> &str {
self.0.as_ref()
}
}
/// Error that indicates a `Regexp` was malformed at runtime.
///
/// This error is typically generated by [`Regexp::compile`].
///
/// This error corresponds to the [Ruby `RegexpError` Exception class].
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::RegexpError;
/// let err = RegexpError::new();
/// assert_eq!(err.message(), "RegexpError");
///
/// let err = RegexpError::with_message(r"invalid multibyte character: /\xFF\xFE/");
/// assert_eq!(err.message(), r"invalid multibyte character: /\xFF\xFE/");
/// ```
///
/// [`Regexp::compile`]: https://ruby-doc.org/core-3.1.2/Regexp.html#method-c-compile
/// [Ruby `RegexpError` Exception class]: https://ruby-doc.org/core-3.1.2/RegexpError.html
#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub struct RegexpError(Cow<'static, str>);
impl From<&'static str> for RegexpError {
#[inline]
fn from(message: &'static str) -> Self {
Self::with_message(message)
}
}
impl From<String> for RegexpError {
fn from(message: String) -> Self {
Self(Cow::Owned(message))
}
}
impl fmt::Display for RegexpError {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(self.message())
}
}
impl error::Error for RegexpError {}
impl RegexpError {
/// Construct a new, default regexp error.
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::RegexpError;
/// const ERR: RegexpError = RegexpError::new();
/// assert_eq!(ERR.message(), "RegexpError");
/// ```
#[inline]
#[must_use]
pub const fn new() -> Self {
Self(Cow::Borrowed("RegexpError"))
}
/// Construct a new regexp error with a message.
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::RegexpError;
/// const ERR: RegexpError = RegexpError::with_message(r"invalid multibyte character: /\xFF\xFE/");
/// assert_eq!(ERR.message(), r"invalid multibyte character: /\xFF\xFE/");
/// ```
#[inline]
#[must_use]
pub const fn with_message(message: &'static str) -> Self {
Self(Cow::Borrowed(message))
}
/// Retrieve the exception message associated with this regexp error.
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::RegexpError;
/// let err = RegexpError::new();
/// assert_eq!(err.message(), "RegexpError");
///
/// let err = RegexpError::with_message(r"invalid multibyte character: /\xFF\xFE/");
/// assert_eq!(err.message(), r"invalid multibyte character: /\xFF\xFE/");
/// ```
#[inline]
#[must_use]
pub fn message(&self) -> &str {
&self.0
}
}
/// Error that indicates a given `Regexp` pattern could not be parsed when given
/// as a `/.../` literal in Ruby source code.
///
/// This error is typically generated at parse-time.
///
/// This error corresponds to the [Ruby `SyntaxError` Exception class].
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::SyntaxError;
/// let err = SyntaxError::new();
/// assert_eq!(err.message(), "SyntaxError");
///
/// let err = SyntaxError::with_message("premature end of char-class");
/// assert_eq!(err.message(), "premature end of char-class");
/// ```
///
/// [Ruby `SyntaxError` Exception class]: https://ruby-doc.org/core-3.1.2/SyntaxError.html
#[derive(Debug, Clone, Hash, PartialEq, Eq, PartialOrd, Ord)]
pub struct SyntaxError(Cow<'static, str>);
impl From<&'static str> for SyntaxError {
#[inline]
fn from(message: &'static str) -> Self {
Self::with_message(message)
}
}
impl From<String> for SyntaxError {
fn from(message: String) -> Self {
Self(Cow::Owned(message))
}
}
impl fmt::Display for SyntaxError {
#[inline]
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(self.message())
}
}
impl error::Error for SyntaxError {}
impl SyntaxError {
/// Construct a new, default syntax error.
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::SyntaxError;
/// const ERR: SyntaxError = SyntaxError::new();
/// assert_eq!(ERR.message(), "SyntaxError");
/// ```
#[inline]
#[must_use]
pub const fn new() -> Self {
Self(Cow::Borrowed("SyntaxError"))
}
/// Construct a new syntax error with a message.
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::SyntaxError;
/// const ERR: SyntaxError = SyntaxError::with_message("premature end of char-class");
/// assert_eq!(ERR.message(), "premature end of char-class");
/// ```
#[inline]
#[must_use]
pub const fn with_message(message: &'static str) -> Self {
Self(Cow::Borrowed(message))
}
/// Retrieve the exception message associated with this syntax error.
///
/// # Examples
///
/// ```
/// # use spinoso_regexp::SyntaxError;
/// let err = SyntaxError::new();
/// assert_eq!(err.message(), "SyntaxError");
///
/// let err = SyntaxError::with_message("premature end of char-class");
/// assert_eq!(err.message(), "premature end of char-class");
/// ```
#[inline]
#[must_use]
pub fn message(&self) -> &str {
&self.0
}
}