1
Fork 0

Explain drop a bit more

Fixes #30655
This commit is contained in:
Steve Klabnik 2016-01-04 12:19:48 -05:00
parent 191ff2d8fd
commit 3385fba264

View file

@ -95,6 +95,16 @@ use fmt;
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
pub trait Drop { pub trait Drop {
/// A method called when the value goes out of scope. /// A method called when the value goes out of scope.
///
/// When this method has been called, `self` has not yet been deallocated.
/// If it were, `self` would be a dangling reference.
///
/// After this function is over, the memory of `self` will be deallocated.
///
/// # Panics
///
/// Given that a `panic!` will call `drop()` as it unwinds, any `panic!` in
/// a `drop()` implementation will likely abort.
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]
fn drop(&mut self); fn drop(&mut self);
} }