softbuffer/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
use raw_window_handle::{HandleError, RawDisplayHandle, RawWindowHandle};
use std::error::Error;
use std::fmt;
use std::num::NonZeroU32;
#[derive(Debug)]
#[non_exhaustive]
/// A sum type of all of the errors that can occur during the operation of this crate.
pub enum SoftBufferError {
/// A [`raw-window-handle`] error occurred.
///
/// [`raw-window-handle`]: raw_window_handle
RawWindowHandle(HandleError),
/// The [`RawDisplayHandle`] passed into [`Context::new`] is not supported by this crate.
///
/// [`RawDisplayHandle`]: raw_window_handle::RawDisplayHandle
/// [`Context::new`]: crate::Context::new
UnsupportedDisplayPlatform {
/// The platform name of the display that was passed into [`Context::new`].
///
/// This is a human-readable string that describes the platform of the display that was
/// passed into [`Context::new`]. The value is not guaranteed to be stable and this
/// exists for debugging purposes only.
///
/// [`Context::new`]: crate::Context::new
human_readable_display_platform_name: &'static str,
/// The [`RawDisplayHandle`] that was passed into [`Context::new`].
///
/// [`RawDisplayHandle`]: raw_window_handle::RawDisplayHandle
/// [`Context::new`]: crate::Context::new
display_handle: RawDisplayHandle,
},
/// The [`RawWindowHandle`] passed into [`Surface::new`] is not supported by this crate.
///
/// [`RawWindowHandle`]: raw_window_handle::RawWindowHandle
/// [`Surface::new`]: crate::Surface::new
UnsupportedWindowPlatform {
/// The platform name of the window that was passed into [`Surface::new`].
///
/// This is a human-readable string that describes the platform of the window that was
/// passed into [`Surface::new`]. The value is not guaranteed to be stable and this
/// exists for debugging purposes only.
///
/// [`Surface::new`]: crate::Surface::new
human_readable_window_platform_name: &'static str,
/// The platform name of the display used by the [`Context`].
///
/// It is possible for a window to be created on a different type of display than the
/// display that was passed into [`Context::new`]. This is a human-readable string that
/// describes the platform of the display that was passed into [`Context::new`]. The value
/// is not guaranteed to be stable and this exists for debugging purposes only.
///
/// [`Context`]: crate::Context
/// [`Context::new`]: crate::Context::new
human_readable_display_platform_name: &'static str,
/// The [`RawWindowHandle`] that was passed into [`Surface::new`].
///
/// [`RawWindowHandle`]: raw_window_handle::RawWindowHandle
/// [`Surface::new`]: crate::Surface::new
window_handle: RawWindowHandle,
},
/// The [`RawWindowHandle`] passed into [`Surface::new`] is missing necessary fields.
///
/// [`RawWindowHandle`]: raw_window_handle::RawWindowHandle
/// [`Surface::new`]: crate::Surface::new
IncompleteWindowHandle,
/// The [`RawDisplayHandle`] passed into [`Context::new`] is missing necessary fields.
///
/// [`RawDisplayHandle`]: raw_window_handle::RawDisplayHandle
/// [`Context::new`]: crate::Context::new
IncompleteDisplayHandle,
/// The provided size is outside of the range supported by the backend.
SizeOutOfRange {
/// The width that was out of range.
width: NonZeroU32,
/// The height that was out of range.
height: NonZeroU32,
},
/// The provided damage rect is outside of the range supported by the backend.
DamageOutOfRange {
/// The damage rect that was out of range.
rect: crate::Rect,
},
/// A platform-specific backend error occurred.
///
/// The first field provides a human-readable description of the error. The second field
/// provides the actual error that occurred. Note that the second field is, under the hood,
/// a private wrapper around the actual error, preventing the user from downcasting to the
/// actual error type.
PlatformError(Option<String>, Option<Box<dyn Error>>),
/// This function is unimplemented on this platform.
Unimplemented,
}
impl fmt::Display for SoftBufferError {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::RawWindowHandle(err) => fmt::Display::fmt(err, f),
Self::UnsupportedDisplayPlatform {
human_readable_display_platform_name,
display_handle,
} => write!(
f,
"The provided display returned an unsupported platform: {}.\nDisplay handle: {:?}",
human_readable_display_platform_name, display_handle
),
Self::UnsupportedWindowPlatform {
human_readable_window_platform_name,
human_readable_display_platform_name,
window_handle,
} => write!(
f,
"The provided window returned an unsupported platform: {}, {}.\nWindow handle: {:?}",
human_readable_window_platform_name, human_readable_display_platform_name, window_handle
),
Self::IncompleteWindowHandle => write!(f, "The provided window handle is null."),
Self::IncompleteDisplayHandle => write!(f, "The provided display handle is null."),
Self::SizeOutOfRange { width, height } => write!(
f,
"Surface size {width}x{height} out of range for backend.",
),
Self::PlatformError(msg, None) => write!(f, "Platform error: {msg:?}"),
Self::PlatformError(msg, Some(err)) => write!(f, "Platform error: {msg:?}: {err}"),
Self::DamageOutOfRange { rect } => write!(
f,
"Damage rect {}x{} at ({}, {}) out of range for backend.",
rect.width, rect.height, rect.x, rect.y
),
Self::Unimplemented => write!(f, "This function is unimplemented on this platform."),
}
}
}
impl std::error::Error for SoftBufferError {
fn source(&self) -> Option<&(dyn Error + 'static)> {
match self {
Self::RawWindowHandle(err) => Some(err),
Self::PlatformError(_, err) => err.as_deref(),
_ => None,
}
}
}
impl From<HandleError> for SoftBufferError {
fn from(err: HandleError) -> Self {
Self::RawWindowHandle(err)
}
}
/// Simple unit error type used to bubble up rejected platforms.
pub(crate) enum InitError<D> {
/// Failed to initialize.
Failure(SoftBufferError),
/// Cannot initialize this handle on this platform.
Unsupported(D),
}
impl<T> From<SoftBufferError> for InitError<T> {
fn from(err: SoftBufferError) -> Self {
Self::Failure(err)
}
}
impl<T> From<HandleError> for InitError<T> {
fn from(err: HandleError) -> Self {
Self::Failure(err.into())
}
}
/// Convenient wrapper to cast errors into SoftBufferError.
pub(crate) trait SwResultExt<T> {
fn swbuf_err(self, msg: impl Into<String>) -> Result<T, SoftBufferError>;
}
impl<T, E: std::error::Error + 'static> SwResultExt<T> for Result<T, E> {
fn swbuf_err(self, msg: impl Into<String>) -> Result<T, SoftBufferError> {
self.map_err(|e| {
SoftBufferError::PlatformError(Some(msg.into()), Some(Box::new(LibraryError(e))))
})
}
}
impl<T> SwResultExt<T> for Option<T> {
fn swbuf_err(self, msg: impl Into<String>) -> Result<T, SoftBufferError> {
self.ok_or_else(|| SoftBufferError::PlatformError(Some(msg.into()), None))
}
}
/// A wrapper around a library error.
///
/// This prevents `x11-dl` and `x11rb` from becoming public dependencies, since users cannot downcast
/// to this type.
struct LibraryError<E>(E);
impl<E: fmt::Debug> fmt::Debug for LibraryError<E> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Debug::fmt(&self.0, f)
}
}
impl<E: fmt::Display> fmt::Display for LibraryError<E> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Display::fmt(&self.0, f)
}
}
impl<E: fmt::Debug + fmt::Display> std::error::Error for LibraryError<E> {}