analyze: rewrite::convert: clarify comment about nested OptionMapBegi…

…n/End
immunant · Jun 3, 2024 · ff20263 · ff20263
1 parent ceccafe
commit ff20263
Showing 1 changed file with 4 additions and 1 deletion.
diff --git a/c2rust-analyze/src/rewrite/expr/convert.rs b/c2rust-analyze/src/rewrite/expr/convert.rs
@@ -323,7 +323,10 @@ impl<'tcx> ConvertVisitor<'tcx> {
         ) -> Option<(&[DistRewrite], &[DistRewrite])> {
             for (i, mir_rw) in mir_rws.iter().enumerate() {
                 match mir_rw.rw {
-                    // Bail out if we see nested delimiters.
+                    // Bail out if we see nested delimiters.  This prevents the special
+                    // `Option::map` rewrite from applying, so the caller will fall back on the
+                    // `unwrap()` + `Some(_)` rewrites for `OptionMapBegin/End` that are
+                    // implemented in `convert_cast_rewrite`.
                     mir_op::RewriteKind::OptionMapBegin => return None,
                     mir_op::RewriteKind::OptionMapEnd => {
                         let (a, b) = mir_rws.split_at(i);