# Struct backtrace::Symbol [−] [src]

    pub struct Symbol { /* fields omitted */ }

A trait representing the resolution of a symbol in a file.

This trait is yielded as a trait object to the closure given to the `backtrace::resolve` function, and it is virtually dispatched as it's unknown which implementation is behind it.

A symbol can give contextual information about a function, for example the name, filename, line number, precise address, etc. Not all information is always available in a symbol, however, so all methods return an `Option`.

## Methods

### `impl Symbol`
[src]

#### `pub fn name(&self) -> Option<SymbolName>`
[src]

Returns the name of this function.

The returned structure can be used to query various properties about the symbol name:

- The `Display` implementation will print out the demangled symbol.
- The raw `str` value of the symbol can be accessed (if it's valid utf-8).
- The raw bytes for the symbol name can be accessed.

#### `pub fn addr(&self) -> Option<*mut c_void>`
[src]

Returns the starting address of this function.

#### `pub fn filename(&self) -> Option<&Path>`
[src]

Returns the file name where this function was defined.

This is currently only available when libbacktrace is being used (e.g. unix platforms other than OSX) and when a binary is compiled with debuginfo. If neither of these conditions is met then this will likely return `None`.

#### `pub fn lineno(&self) -> Option<u32>`
[src]

Returns the line number for where this symbol is currently executing.

This return value is typically `Some` if `filename` returns `Some`, and is consequently subject to similar caveats.

## Trait Implementations

### `impl Debug for Symbol`
[src]

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

Formats the value using the given formatter. 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`)