fyrox_impl/engine/error.rs
1// Copyright (c) 2019-present Dmitry Stepanov and Fyrox Engine contributors.
2//
3// Permission is hereby granted, free of charge, to any person obtaining a copy
4// of this software and associated documentation files (the "Software"), to deal
5// in the Software without restriction, including without limitation the rights
6// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7// copies of the Software, and to permit persons to whom the Software is
8// furnished to do so, subject to the following conditions:
9//
10// The above copyright notice and this permission notice shall be included in all
11// copies or substantial portions of the Software.
12//
13// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
19// SOFTWARE.
20
21//! All possible errors that can happen in the engine.
22
23use crate::{renderer::framework::error::FrameworkError, scene::sound::SoundError};
24use std::error::Error;
25use std::fmt::{Debug, Display, Formatter};
26
27/// See module docs.
28#[derive(Debug)]
29pub enum EngineError {
30 /// Sound system error.
31 Sound(SoundError),
32 /// Rendering system error.
33 Renderer(FrameworkError),
34 /// Internal error.
35 Custom(String),
36}
37
38impl Display for EngineError {
39 fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
40 match self {
41 EngineError::Sound(v) => Display::fmt(v, f),
42 EngineError::Renderer(v) => Display::fmt(v, f),
43 EngineError::Custom(v) => {
44 write!(f, "Custom error: {v}")
45 }
46 }
47 }
48}
49
50impl From<SoundError> for EngineError {
51 fn from(sound: SoundError) -> Self {
52 Self::Sound(sound)
53 }
54}
55
56impl From<FrameworkError> for EngineError {
57 fn from(renderer: FrameworkError) -> Self {
58 Self::Renderer(renderer)
59 }
60}
61
62impl From<Box<dyn Error>> for EngineError {
63 fn from(e: Box<dyn Error>) -> Self {
64 Self::Custom(format!("{e:?}"))
65 }
66}