about summary refs log tree commit diff
diff options
context:
space:
mode:
authorRalf Jung <post@ralfj.de>2019-06-07 15:51:29 +0200
committerRalf Jung <post@ralfj.de>2019-06-07 15:51:29 +0200
commit524f1463cd6b0025d77f34e6911bce6e37c3e8ea (patch)
tree78c4fd2eacd4bc5572e96adf9ae9b3948362cc59
parent625763fddd4281200f0f244a601f659fa1782de5 (diff)
downloadrust-524f1463cd6b0025d77f34e6911bce6e37c3e8ea.tar.gz
rust-524f1463cd6b0025d77f34e6911bce6e37c3e8ea.zip
add doc comment for EvalError
-rw-r--r--src/librustc/mir/interpret/error.rs5
1 files changed, 5 insertions, 0 deletions
diff --git a/src/librustc/mir/interpret/error.rs b/src/librustc/mir/interpret/error.rs
index 83204dcf62b..e324abd8e2f 100644
--- a/src/librustc/mir/interpret/error.rs
+++ b/src/librustc/mir/interpret/error.rs
@@ -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>,