# [−][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]

#### `pub fn with_strategy(v: T, dropfn: F) -> ScopeGuard<T, F, S>`[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> DerefMut for ScopeGuard<T, F, S> where
F: FnMut(&mut T),` [src]

#### `fn deref_mut(&mut self) -> &mut T`[src]

Mutably dereferences the value.

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

#### `type Target = T`

The resulting type after dereferencing.

#### `fn deref(&self) -> &T`[src]

Dereferences the value.

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

#### `fn drop(&mut self)`[src]

Executes the destructor for this type. Read more

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

#### `fn fmt(&self, f: &mut Formatter) -> Result`[src]

Formats the value using the given formatter. Read more

## Auto Trait Implementations

### `impl<T, F, S> Unpin for ScopeGuard<T, F, S> where
F: Unpin,
S: Unpin,
T: Unpin,`

### `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<T> for T`[src]

#### `fn from(t: T) -> T`[src]

Performs the conversion.

### `impl<T, U> TryFrom<U> for T where
U: Into<T>,` [src]

#### `type Error = Infallible`

The type returned in the event of a conversion error.

#### `fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>`[src]

Performs the conversion.

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

#### `fn into(self) -> U`[src]

Performs the conversion.

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

#### `type Error = <U as TryFrom<T>>::Error`

The type returned in the event of a conversion error.

#### `fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>`[src]

Performs the conversion.

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

#### `fn borrow(&self) -> &T`[src]

Immutably borrows from an owned value. Read more

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

#### `fn borrow_mut(&mut self) -> &mut T`[src]

Mutably borrows from an owned value. Read more

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

#### `fn type_id(&self) -> TypeId`[src]

Gets the `TypeId` of `self`. Read more

# Help

## Keyboard Shortcuts

`?`
  Show this help dialog
`S`
  Focus the search field
`↑`
  Move up in search results
`↓`
  Move down in search results
`↹`
  Switch tab
`⏎`
  Go to active search result
`+`
  Expand all sections
`-`
  Collapse all sections

## Search Tricks

Prefix searches with a type followed by a colon (e.g., `fn:`) to restrict the search to a given type.

Accepted types are: `fn`, `mod`, `struct`, `enum`, `trait`, `type`, `macro`, and `const`.

Search functions by type signature (e.g., `vec -> usize` or `* -> vec`)

Search multiple things at once by splitting your query with comma (e.g., `str,u8` or `String,struct:Vec,test`)