rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Clarify docs of RefCell

Browse Source 
Comparison operators only panic if the `RefCell` is mutably borrowed, and `RefCell::swap()` can also panic if swapping a `RefCell` with itself.
This commit is contained in:
Chayim Refael Friedman
2022-11-02 15:38:15 +02:00
committed by GitHub
parent 822f8c22f5
commit d2eb2bb854
1 changed files with 9 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
library/core/src/cell.rs
View File

@@ -807,7 +807,8 @@ impl<T> RefCell<T> {
/// ///
/// # Panics /// # Panics
/// ///
/// Panics if the value in either `RefCell` is currently borrowed. /// Panics if the value in either `RefCell` is currently borrowed, or
/// if `self` and `other` point to the same `RefCell`.
/// ///
/// # Examples /// # Examples
/// ///
@@ -1193,7 +1194,7 @@ impl<T: Default> Default for RefCell<T> {
impl<T: ?Sized + PartialEq> PartialEq for RefCell<T> { impl<T: ?Sized + PartialEq> PartialEq for RefCell<T> {
/// # Panics /// # Panics
/// ///
/// Panics if the value in either `RefCell` is currently borrowed. /// Panics if the value in either `RefCell` is currently mutably borrowed.
#[inline] #[inline]
fn eq(&self, other: &RefCell<T>) -> bool { fn eq(&self, other: &RefCell<T>) -> bool {
*self.borrow() == *other.borrow() *self.borrow() == *other.borrow()
@@ -1207,7 +1208,7 @@ impl<T: ?Sized + Eq> Eq for RefCell<T> {}
impl<T: ?Sized + PartialOrd> PartialOrd for RefCell<T> { impl<T: ?Sized + PartialOrd> PartialOrd for RefCell<T> {
/// # Panics /// # Panics
/// ///
/// Panics if the value in either `RefCell` is currently borrowed. /// Panics if the value in either `RefCell` is currently mutably borrowed.
#[inline] #[inline]
fn partial_cmp(&self, other: &RefCell<T>) -> Option<Ordering> { fn partial_cmp(&self, other: &RefCell<T>) -> Option<Ordering> {
self.borrow().partial_cmp(&*other.borrow()) self.borrow().partial_cmp(&*other.borrow())
@@ -1215,7 +1216,7 @@ impl<T: ?Sized + PartialOrd> PartialOrd for RefCell<T> {
/// # Panics /// # Panics
/// ///
/// Panics if the value in either `RefCell` is currently borrowed. /// Panics if the value in either `RefCell` is currently mutably borrowed.
#[inline] #[inline]
fn lt(&self, other: &RefCell<T>) -> bool { fn lt(&self, other: &RefCell<T>) -> bool {
*self.borrow() < *other.borrow() *self.borrow() < *other.borrow()
@@ -1223,7 +1224,7 @@ impl<T: ?Sized + PartialOrd> PartialOrd for RefCell<T> {
/// # Panics /// # Panics
/// ///
/// Panics if the value in either `RefCell` is currently borrowed. /// Panics if the value in either `RefCell` is currently mutably borrowed.
#[inline] #[inline]
fn le(&self, other: &RefCell<T>) -> bool { fn le(&self, other: &RefCell<T>) -> bool {
*self.borrow() <= *other.borrow() *self.borrow() <= *other.borrow()
@@ -1231,7 +1232,7 @@ impl<T: ?Sized + PartialOrd> PartialOrd for RefCell<T> {
/// # Panics /// # Panics
/// ///
/// Panics if the value in either `RefCell` is currently borrowed. /// Panics if the value in either `RefCell` is currently mutably borrowed.
#[inline] #[inline]
fn gt(&self, other: &RefCell<T>) -> bool { fn gt(&self, other: &RefCell<T>) -> bool {
*self.borrow() > *other.borrow() *self.borrow() > *other.borrow()
@@ -1239,7 +1240,7 @@ impl<T: ?Sized + PartialOrd> PartialOrd for RefCell<T> {
/// # Panics /// # Panics
/// ///
/// Panics if the value in either `RefCell` is currently borrowed. /// Panics if the value in either `RefCell` is currently mutably borrowed.
#[inline] #[inline]
fn ge(&self, other: &RefCell<T>) -> bool { fn ge(&self, other: &RefCell<T>) -> bool {
*self.borrow() >= *other.borrow() *self.borrow() >= *other.borrow()
@@ -1250,7 +1251,7 @@ impl<T: ?Sized + PartialOrd> PartialOrd for RefCell<T> {
impl<T: ?Sized + Ord> Ord for RefCell<T> { impl<T: ?Sized + Ord> Ord for RefCell<T> {
/// # Panics /// # Panics
/// ///
/// Panics if the value in either `RefCell` is currently borrowed. /// Panics if the value in either `RefCell` is currently mutably borrowed.
#[inline] #[inline]
fn cmp(&self, other: &RefCell<T>) -> Ordering { fn cmp(&self, other: &RefCell<T>) -> Ordering {
self.borrow().cmp(&*other.borrow()) self.borrow().cmp(&*other.borrow())