add doc comment for EvalError

This commit is contained in:
Ralf Jung 2019-06-07 15:51:29 +02:00
parent 625763fddd
commit 524f1463cd

View File

@ -179,6 +179,11 @@ pub fn struct_error<'a, 'gcx, 'tcx>(
struct_span_err!(tcx.sess, tcx.span, E0080, "{}", msg)
}
/// Packages the kind of error we got from the const code interpreter
/// up with a Rust-level backtrace of where the error occured.
/// Thsese should always be constructed by calling `.into()` on
/// a `InterpError`. In `librustc_mir::interpret`, we have the `err!`
/// macro for this
#[derive(Debug, Clone)]
pub struct EvalError<'tcx> {
pub kind: InterpError<'tcx, u64>,