#take #mut #patterns

take_mut

Take a T from a &mut T temporarily

7 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

#23 in Rust patterns

Download history 2180/week @ 2018-10-25 2766/week @ 2018-11-01 3366/week @ 2018-11-08 3305/week @ 2018-11-15 2743/week @ 2018-11-22 3204/week @ 2018-11-29 2772/week @ 2018-12-06 3147/week @ 2018-12-13 3212/week @ 2018-12-20 2290/week @ 2018-12-27 2754/week @ 2019-01-03 3883/week @ 2019-01-10 7422/week @ 2019-01-17

8,174 downloads per month
Used in 92 crates (11 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