Rollup merge of rust-lang#109058 - tmiasko:is-checkable, r=jackh726

matthiaskrgr · web-flow · commit 9fc8de0caa14 · 2023-03-13T21:55:37.000+01:00
Document BinOp::is_checkable
diff --git a/compiler/rustc_middle/src/mir/mod.rs b/compiler/rustc_middle/src/mir/mod.rs
@@ -1999,6 +1999,9 @@ impl BorrowKind {
 }
 
 impl BinOp {
+    /// The checkable operators are those whose overflow checking behavior is controlled by
+    /// -Coverflow-checks option. The remaining operators have either no overflow conditions (e.g.,
+    /// BitAnd, BitOr, BitXor) or are always checked for overflow (e.g., Div, Rem).
     pub fn is_checkable(self) -> bool {
         use self::BinOp::*;
         matches!(self, Add | Sub | Mul | Shl | Shr)

Original file line number	Diff line number	Diff line change
`@@ -1999,6 +1999,9 @@ impl BorrowKind {`
`1999`	`1999`	`}`
`2000`	`2000`
`2001`	`2001`	`impl BinOp {`
	`2002`	`+ /// The checkable operators are those whose overflow checking behavior is controlled by`
	`2003`	`+ /// -Coverflow-checks option. The remaining operators have either no overflow conditions (e.g.,`
	`2004`	`+ /// BitAnd, BitOr, BitXor) or are always checked for overflow (e.g., Div, Rem).`
`2002`	`2005`	`pub fn is_checkable(self) -> bool {`
`2003`	`2006`	`use self::BinOp::*;`
`2004`	`2007`	`matches!(self, Add \| Sub \| Mul \| Shl \| Shr)`