Trait std::ops::Drop

#[lang = "drop"]
pub trait Drop {
    fn drop(&mut self);
}

Used to run some code when a value goes out of scope. This is sometimes called a 'destructor'.

When a value goes out of scope, it will have its drop method called if its type implements Drop. Then, any fields the value contains will also be dropped recursively.

Because of this recursive dropping, you do not need to implement this trait unless your type needs its own destructor logic.

Refer to the chapter on Drop in The Rust Programming Language for some more elaboration.

Examples

Implementing Drop

The drop method is called when _x goes out of scope, and therefore main prints Dropping!.

struct HasDrop;

impl Drop for HasDrop {
    fn drop(&mut self) {
        println!("Dropping!");
    }
}

fn main() {
    let _x = HasDrop;
}

Dropping is done recursively

When outer goes out of scope, the drop method will be called first for Outer, then for Inner. Therefore, main prints Dropping Outer! and then Dropping Inner!.

struct Inner;
struct Outer(Inner);

impl Drop for Inner {
    fn drop(&mut self) {
        println!("Dropping Inner!");
    }
}

impl Drop for Outer {
    fn drop(&mut self) {
        println!("Dropping Outer!");
    }
}

fn main() {
    let _x = Outer(Inner);
}

Variables are dropped in reverse order of declaration

_first is declared first and _second is declared second, so main will print Declared second! and then Declared first!.

struct PrintOnDrop(&'static str);

impl Drop for PrintOnDrop {
    fn drop(&mut self) {
        println!("{}", self.0);
    }
}

fn main() {
    let _first = PrintOnDrop("Declared first!");
    let _second = PrintOnDrop("Declared second!");
}

Required methods

fn drop(&mut self)

Executes the destructor for this type.

This method is called implicitly when the value goes out of scope, and cannot be called explicitly (this is compiler error E0040). However, the std::mem::drop function in the prelude can be used to call the argument's Drop implementation.

When this method has been called, self has not yet been deallocated. That only happens after the method is over. If this wasn't the case, self would be a dangling reference.

Panics

Given that a panic! will call drop as it unwinds, any panic! in a drop implementation will likely abort.

Loading content...

Implementors

impl Drop for CString

fn drop(&mut self)

impl Drop for Condvar

fn drop(&mut self)

impl Drop for Waker

fn drop(&mut self)

impl<'_> Drop for std::string::Drain<'_>

fn drop(&mut self)

impl<'_, I> Drop for Splice<'_, I> where
    I: Iterator, 

fn drop(&mut self)

impl<'_, T> Drop for PeekMut<'_, T> where
    T: Ord, 

fn drop(&mut self)

impl<'_, T> Drop for std::collections::vec_deque::Drain<'_, T>

fn drop(&mut self)

impl<'_, T> Drop for std::vec::Drain<'_, T>

fn drop(&mut self)

impl<'_, T, F> Drop for std::collections::linked_list::DrainFilter<'_, T, F> where
    F: FnMut(&mut T) -> bool, 

fn drop(&mut self)

impl<'_, T, F> Drop for std::vec::DrainFilter<'_, T, F> where
    F: FnMut(&mut T) -> bool, 

fn drop(&mut self)

impl<K, V> Drop for BTreeMap<K, V>

fn drop(&mut self)

impl<K, V> Drop for std::collections::btree_map::IntoIter<K, V>

fn drop(&mut self)

impl<T> Drop for Box<T> where
    T: ?Sized, 

fn drop(&mut self)

impl<T> Drop for LinkedList<T>

fn drop(&mut self)

impl<T> Drop for VecDeque<T>

fn drop(&mut self)

impl<T> Drop for Rc<T> where
    T: ?Sized, 

fn drop(&mut self)

Drops the Rc.

This will decrement the strong reference count. If the strong reference count reaches zero then the only other references (if any) are Weak, so we drop the inner value.

Examples

use std::rc::Rc;

struct Foo;

impl Drop for Foo {
    fn drop(&mut self) {
        println!("dropped!");
    }
}

let foo  = Rc::new(Foo);
let foo2 = Rc::clone(&foo);

drop(foo);    // Doesn't print anything
drop(foo2);   // Prints "dropped!"

impl<T> Drop for std::rc::Weak<T> where
    T: ?Sized, 

fn drop(&mut self)

Drops the Weak pointer.

Examples

use std::rc::{Rc, Weak};

struct Foo;

impl Drop for Foo {
    fn drop(&mut self) {
        println!("dropped!");
    }
}

let foo = Rc::new(Foo);
let weak_foo = Rc::downgrade(&foo);
let other_weak_foo = Weak::clone(&weak_foo);

drop(weak_foo);   // Doesn't print anything
drop(foo);        // Prints "dropped!"

assert!(other_weak_foo.upgrade().is_none());

impl<T> Drop for Receiver<T>

fn drop(&mut self)

impl<T> Drop for Sender<T>

fn drop(&mut self)

impl<T> Drop for SyncSender<T>

fn drop(&mut self)

impl<T> Drop for Arc<T> where
    T: ?Sized, 

fn drop(&mut self)

Drops the Arc.

This will decrement the strong reference count. If the strong reference count reaches zero then the only other references (if any) are Weak, so we drop the inner value.

Examples

use std::sync::Arc;

struct Foo;

impl Drop for Foo {
    fn drop(&mut self) {
        println!("dropped!");
    }
}

let foo  = Arc::new(Foo);
let foo2 = Arc::clone(&foo);

drop(foo);    // Doesn't print anything
drop(foo2);   // Prints "dropped!"

impl<T> Drop for std::sync::Weak<T> where
    T: ?Sized, 

fn drop(&mut self)

Drops the Weak pointer.

Examples

use std::sync::{Arc, Weak};

struct Foo;

impl Drop for Foo {
    fn drop(&mut self) {
        println!("dropped!");
    }
}

let foo = Arc::new(Foo);
let weak_foo = Arc::downgrade(&foo);
let other_weak_foo = Weak::clone(&weak_foo);

drop(weak_foo);   // Doesn't print anything
drop(foo);        // Prints "dropped!"

assert!(other_weak_foo.upgrade().is_none());

impl<T> Drop for std::vec::IntoIter<T>

fn drop(&mut self)

impl<T> Drop for Vec<T>

fn drop(&mut self)

impl<T: ?Sized> Drop for Mutex<T>

fn drop(&mut self)

impl<T: ?Sized> Drop for RwLock<T>

fn drop(&mut self)

impl<T: ?Sized, '_> Drop for MutexGuard<'_, T>

fn drop(&mut self)

impl<T: ?Sized, '_> Drop for RwLockReadGuard<'_, T>

fn drop(&mut self)

impl<T: ?Sized, '_> Drop for RwLockWriteGuard<'_, T>

fn drop(&mut self)

impl<W: Write> Drop for BufWriter<W>

fn drop(&mut self)

Loading content...