diff options
| author | Tyler Mandry <tmandry@gmail.com> | 2019-10-18 13:48:25 -0700 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-10-18 13:48:25 -0700 |
| commit | ea5a1843833a4c7720d3becfe79853a32f8de60b (patch) | |
| tree | a2ff18503fd9d58c776144da6c49225a6406466c | |
| parent | e27e39b7b20c4e4962a5ba0ab94dc68c6a3ed30c (diff) | |
| parent | 83e97c6ac1b722c1b55fdf9d6378f87d9e0cdbdd (diff) | |
| download | rust-ea5a1843833a4c7720d3becfe79853a32f8de60b.tar.gz rust-ea5a1843833a4c7720d3becfe79853a32f8de60b.zip | |
Rollup merge of #65496 - tspiteri:euc-div-panic, r=KodrAus
properly document panics in div_euclid and rem_euclid For signed numbers, document that `div_euclid` and `rem_euclid` panic not just when `rhs` is 0, but also when the division overflows. For unsigned numbers, document that `div_euclid` and `rem_euclid` panic when `rhs` is 0.
| -rw-r--r-- | src/libcore/num/mod.rs | 12 |
1 files changed, 10 insertions, 2 deletions
diff --git a/src/libcore/num/mod.rs b/src/libcore/num/mod.rs index 998c8f81652..8f4ade377e3 100644 --- a/src/libcore/num/mod.rs +++ b/src/libcore/num/mod.rs @@ -1864,7 +1864,7 @@ if `self < 0`, this is equal to round towards +/- infinity. # Panics -This function will panic if `rhs` is 0. +This function will panic if `rhs` is 0 or the division results in overflow. # Examples @@ -1903,7 +1903,7 @@ This is done as if by the Euclidean division algorithm -- given # Panics -This function will panic if `rhs` is 0. +This function will panic if `rhs` is 0 or the division results in overflow. # Examples @@ -3694,6 +3694,10 @@ Since, for the positive integers, all common definitions of division are equal, this is exactly equal to `self / rhs`. +# Panics + +This function will panic if `rhs` is 0. + # Examples Basic usage: @@ -3719,6 +3723,10 @@ Since, for the positive integers, all common definitions of division are equal, this is exactly equal to `self % rhs`. +# Panics + +This function will panic if `rhs` is 0. + # Examples Basic usage: |