Skip to content

Commit 524f146

Browse files
committed
add doc comment for EvalError
1 parent 625763f commit 524f146

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

src/librustc/mir/interpret/error.rs

+5
Original file line numberDiff line numberDiff line change
@@ -179,6 +179,11 @@ pub fn struct_error<'a, 'gcx, 'tcx>(
179179
struct_span_err!(tcx.sess, tcx.span, E0080, "{}", msg)
180180
}
181181

182+
/// Packages the kind of error we got from the const code interpreter
183+
/// up with a Rust-level backtrace of where the error occured.
184+
/// Thsese should always be constructed by calling `.into()` on
185+
/// a `InterpError`. In `librustc_mir::interpret`, we have the `err!`
186+
/// macro for this
182187
#[derive(Debug, Clone)]
183188
pub struct EvalError<'tcx> {
184189
pub kind: InterpError<'tcx, u64>,

0 commit comments

Comments
 (0)