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

//! This library provides alternatives to the standard `.unwrap`* methods on `Result` and `Option` that don't require `Debug` to be implemented on the unexpected variant.
//!
//! # Example
//!
//! Given
//!
//! ```
//! struct T;
//!
//! let none = Option::<T>::None;
//! let ok = Result::<T, T>::Ok(T);
//! let err = Result::<T, T>::Err(T);
//! ```
//!
//! , the following `std` methods are unavailable:
//!
//! ```compile_fail
//! # struct T;
//! # let none = Option::<T>::None;
//! # let ok = Result::<T, T>::Ok(T);
//! # let err = Result::<T, T>::Err(T);
//! #
//! none.unwrap_none(); // Some(T) isn't Debug.
//! ```
//!
//! ```compile_fail
//! # struct T;
//! # let none = Option::<T>::None;
//! # let ok = Result::<T, T>::Ok(T);
//! # let err = Result::<T, T>::Err(T);
//! #
//! ok.unwrap(); // Err(T) isn't Debug.
//! ```
//!
//! ```compile_fail
//! # struct T;
//! # let none = Option::<T>::None;
//! # let ok = Result::<T, T>::Ok(T);
//! # let err = Result::<T, T>::Err(T);
//! #
//! err.unwrap_err(); // Ok(T) isn't Debug.
//! ```
//!
//! The methods in this library can be used in this situation (e.g. when working with generics), but provide less information:
//!
//! Additionally given
//!
//! ```
//! use debugless_unwrap::*;
//! ```
//!
//! , the following work like their `debugless_`-less equivalents:
//!
//! ```
//! # use debugless_unwrap::*;
//! # struct T;
//! # let none = Option::<T>::None;
//! # let ok = Result::<T, T>::Ok(T);
//! # let err = Result::<T, T>::Err(T);
//! #
//! none.debugless_unwrap_none();
//! ```
//!
//! ```
//! # use debugless_unwrap::*;
//! # struct T;
//! # let none = Option::<T>::None;
//! # let ok = Result::<T, T>::Ok(T);
//! # let err = Result::<T, T>::Err(T);
//! #
//! ok.debugless_unwrap();
//! ```
//!
//! ```
//! # use debugless_unwrap::*;
//! # struct T;
//! # let none = Option::<T>::None;
//! # let ok = Result::<T, T>::Ok(T);
//! # let err = Result::<T, T>::Err(T);
//! #
//! err.debugless_unwrap_err();
//! ```

#![doc(html_root_url = "https://docs.rs/debugless-unwrap/0.0.4")]
#![no_std]
#![warn(clippy::pedantic)]

/// Provides `.debugless_unwrap()` on `Result`.
///
/// # Example
///
/// ```
/// use assert_panic::assert_panic;
/// use debugless_unwrap::DebuglessUnwrap;
///
/// struct T;
///
///  let ok = Result::<T, T>::Ok(T);
///  let err = Result::<T, T>::Err(T);
///
/// ok.debugless_unwrap();
///
/// assert_panic!({ err.debugless_unwrap(); });
/// ```
pub trait DebuglessUnwrap {
	type Unwrapped;

	#[track_caller]
	fn debugless_unwrap(self) -> Self::Unwrapped;
}

impl<T, E> DebuglessUnwrap for Result<T, E> {
	type Unwrapped = T;
	fn debugless_unwrap(self) -> Self::Unwrapped {
		match self {
			Ok(unwrapped) => unwrapped,
			Err(_) => panic!("Tried to debugless_unwrap Err value"),
		}
	}
}

/// Provides `.debugless_unwrap_err()` on `Result`.
///
/// # Example
///
/// ```
/// use assert_panic::assert_panic;
/// use debugless_unwrap::DebuglessUnwrapErr;
///
/// struct T;
///
///  let ok = Result::<T, T>::Ok(T);
///  let err = Result::<T, T>::Err(T);
///
/// err.debugless_unwrap_err();
///
/// assert_panic!({ ok.debugless_unwrap_err(); });
/// ```
pub trait DebuglessUnwrapErr {
	type Unwrapped;

	#[track_caller]
	fn debugless_unwrap_err(self) -> Self::Unwrapped;
}

impl<T, E> DebuglessUnwrapErr for Result<T, E> {
	type Unwrapped = E;
	fn debugless_unwrap_err(self) -> Self::Unwrapped {
		match self {
			Ok(_) => panic!("Tried to debugless_unwrap_err Ok value"),
			Err(unwrapped) => unwrapped,
		}
	}
}

/// Provides `.debugless_unwrap_none()` on `Option`.
///
/// # Example
///
/// ```
/// use assert_panic::assert_panic;
/// use debugless_unwrap::DebuglessUnwrapNone;
///
/// struct T;
///
///  let some = Some(T);
///  let none = Option::<T>::None;
///
/// none.debugless_unwrap_none();
///
/// assert_panic!(some.debugless_unwrap_none());
/// ```
pub trait DebuglessUnwrapNone {
	#[track_caller]
	fn debugless_unwrap_none(self);
}

impl<T> DebuglessUnwrapNone for Option<T> {
	fn debugless_unwrap_none(self) {
		if self.is_some() {
			panic!("Tried to debugless_unwrap_none Some value")
		}
	}
}

#[cfg(doctest)]
pub mod readme {
	doc_comment::doctest!("../README.md");
}