# [−][src]Struct hprof::Profiler

    pub struct Profiler { /* fields omitted */ }

A single tree of profile data.

## Methods

### `impl Profiler`[src]

#### `pub fn new(name: &'static str) -> Profiler`[src]

Create a new profiler with the given name for the root node.

#### `pub fn enter(&self, name: &'static str) -> ProfileGuard`[src]

Enter a profile node for `name`, returning a guard object that will `leave` on destruction.

#### `pub fn enter_noguard(&self, name: &'static str)`[src]

Enter a profile node for `name`.

#### `pub fn leave(&self)`[src]

Leave the current profile node.

#### `pub fn print_timing(&self)`[src]

Print out the current timing information in a very naive way.

#### `pub fn root(&self) -> Rc<ProfileNode>`[src]

Return the root profile node for inspection.

This root will always be valid and reflect the current state of the `Profiler`. It is not advised to inspect the data between calls to `start_frame` and `end_frame`.

#### `pub fn end_frame(&self)`[src]

Finish a frame.

Logs an error if there are pending `leave` calls, and later attempts to print timing data will be met with sadness in the form of `NaN`s.

#### `pub fn start_frame(&self)`[src]

Start a frame.

Resets timing data. Logs an error if there are pending `leave` calls, but there are otherwise no ill effects.

#### `pub fn disable(&self)`[src]

Disable the profiler.

All calls until `enable` will do nothing.

#### `pub fn enable(&self)`[src]

Enable the profiler.

Calls will take effect until `disable` is called.

#### `pub fn toggle(&self)`[src]

Toggle the profiler enabledness.

## Auto Trait Implementations

### `impl !Send for Profiler`

### `impl Unpin for Profiler`

### `impl !Sync for Profiler`

### `impl !UnwindSafe for Profiler`

### `impl !RefUnwindSafe for Profiler`

## Blanket Implementations

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

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

Performs the conversion.

### `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> 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> 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> Borrow<T> for T where
T: ?Sized,` [src]

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

Immutably 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`)