diff options
| author | pierwill <19642016+pierwill@users.noreply.github.com> | 2022-07-06 12:48:19 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-07-06 12:48:19 -0500 |
| commit | fb579435a5d25d947df90ddb72932c8f901ac77e (patch) | |
| tree | a8b9d9be6c6ea136008a679a7d3c6ea51650fc48 | |
| parent | 049308cf8b48e9d67e54d6d0b01c10c79d1efc3a (diff) | |
| download | rust-fb579435a5d25d947df90ddb72932c8f901ac77e.tar.gz rust-fb579435a5d25d947df90ddb72932c8f901ac77e.zip | |
docs: Add overview of `rustc_middle::mir::TerminatorKind`
| -rw-r--r-- | compiler/rustc_middle/src/mir/syntax.rs | 2 |
1 files changed, 2 insertions, 0 deletions
diff --git a/compiler/rustc_middle/src/mir/syntax.rs b/compiler/rustc_middle/src/mir/syntax.rs index 5d4f3ea9e4c..499fd84f1b8 100644 --- a/compiler/rustc_middle/src/mir/syntax.rs +++ b/compiler/rustc_middle/src/mir/syntax.rs @@ -396,6 +396,8 @@ pub struct CopyNonOverlapping<'tcx> { /////////////////////////////////////////////////////////////////////////// // Terminators +/// The various kinds of terminators, representing ways of exiting from a basic block. +/// /// A note on unwinding: Panics may occur during the execution of some terminators. Depending on the /// `-C panic` flag, this may either cause the program to abort or the call stack to unwind. Such /// terminators have a `cleanup: Option<BasicBlock>` field on them. If stack unwinding occurs, then |