#take #patterns #mut

take_mut

Take a T from a &mut T temporarily

6 releases

0.2.2 Mar 20, 2018
0.2.1 Mar 15, 2018
0.2.0 Aug 6, 2017
0.1.3 Feb 22, 2016

#57 in Rust patterns

Download history 25710/week @ 2019-08-02 21022/week @ 2019-08-09 20046/week @ 2019-08-16 17251/week @ 2019-08-23 19277/week @ 2019-08-30 21532/week @ 2019-09-06 23131/week @ 2019-09-13 25237/week @ 2019-09-20 24852/week @ 2019-09-27 26258/week @ 2019-10-04 23109/week @ 2019-10-11 27003/week @ 2019-10-18 25489/week @ 2019-10-25 26280/week @ 2019-11-01 29997/week @ 2019-11-08

26,079 downloads per month
Used in 594 crates (10 directly)

MIT license

12KB
204 lines

take_mut

This crate provides (at this time) a single function, take().

take() allows for taking T out of a &mut T, doing anything with it including consuming it, and producing another T to put back in the &mut T.

During take(), if a panic occurs, the entire process will be exited, as there's no valid T to put back into the &mut T.

Contrast with std::mem::replace(), which allows for putting a different T into a &mut T, but requiring the new T to be available before being able to consume the old T.

Example

struct Foo;
let mut foo = Foo;
take_mut::take(&mut foo, |foo| {
    // Can now consume the Foo, and provide a new value later
    drop(foo);
    // Do more stuff
    Foo // Return new Foo from closure, which goes back into the &mut Foo
});

lib.rs:

This crate provides several functions for handling &mut T including take().

take() allows for taking T out of a &mut T, doing anything with it including consuming it, and producing another T to put back in the &mut T.

During take(), if a panic occurs, the entire process will be aborted, as there's no valid T to put back into the &mut T. Use take_or_recover() to replace the &mut T with a recovery value before continuing the panic.

Contrast with std::mem::replace(), which allows for putting a different T into a &mut T, but requiring the new T to be available before being able to consume the old T.

No runtime deps