[][src]Struct scopeguard::ScopeGuard

pub struct ScopeGuard<T, F, S: Strategy = Always> where
    F: FnMut(&mut T), 
{ /* fields omitted */ }

ScopeGuard is a scope guard that may own a protected value.

If you place a guard in a local variable, the closure can run regardless how you leave the scope — through regular return or panic (except if panic or other code aborts; so as long as destructors run). It is run only once.

The S parameter for Strategy determines if the closure actually runs.

The guard's closure will be called with a mut ref to the held value in the destructor. It's called only once.

The ScopeGuard implements Deref so that you can access the inner value.

Methods

impl<T, F, S> ScopeGuard<T, F, S> where
    F: FnMut(&mut T),
    S: Strategy
[src]

Create a ScopeGuard that owns v (accessible through deref) and calls dropfn when its destructor runs.

The Strategy decides whether the scope guard's closure should run.

Trait Implementations

impl<T, F, S: Strategy> Deref for ScopeGuard<T, F, S> where
    F: FnMut(&mut T), 
[src]

The resulting type after dereferencing.

Dereferences the value.

impl<T, F, S> Debug for ScopeGuard<T, F, S> where
    T: Debug,
    F: FnMut(&mut T),
    S: Strategy + Debug
[src]

Formats the value using the given formatter. Read more

impl<T, F, S: Strategy> DerefMut for ScopeGuard<T, F, S> where
    F: FnMut(&mut T), 
[src]

Mutably dereferences the value.

impl<T, F, S: Strategy> Drop for ScopeGuard<T, F, S> where
    F: FnMut(&mut T), 
[src]

Executes the destructor for this type. Read more

Auto Trait Implementations

impl<T, F, S> Send for ScopeGuard<T, F, S> where
    F: Send,
    S: Send,
    T: Send

impl<T, F, S> Sync for ScopeGuard<T, F, S> where
    F: Sync,
    S: Sync,
    T: Sync

Blanket Implementations

impl<T> From for T
[src]

Performs the conversion.

impl<T, U> TryFrom for T where
    T: From<U>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T, U> TryInto for T where
    U: TryFrom<T>, 
[src]

🔬 This is a nightly-only experimental API. (try_from)

The type returned in the event of a conversion error.

🔬 This is a nightly-only experimental API. (try_from)

Performs the conversion.

impl<T, U> Into for T where
    U: From<T>, 
[src]

Performs the conversion.

impl<T> Borrow for T where
    T: ?Sized
[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut for T where
    T: ?Sized
[src]

Mutably borrows from an owned value. Read more

impl<T> Any for T where
    T: 'static + ?Sized
[src]

🔬 This is a nightly-only experimental API. (get_type_id)

this method will likely be replaced by an associated static

Gets the TypeId of self. Read more