microfmt
Zero-allocation C++ formatting for constrained environments
Loading...
Searching...
No Matches
Public Member Functions | List of all members
microfmt::remote_backtrace_view Class Reference

Formattable view rendering a remote backtrace. More...

#include <frame_pointer.hpp>

Public Member Functions

constexpr remote_backtrace_view (frame_pointer_iterator iter, symbol_resolver_ref resolver, symbol_resolution_context &symbol_context RELOCO_LIFETIMEBOUND, uint32_t max_depth=16) noexcept
 Constructs a backtrace view.
 
constexpr frame_pointer_iterator iterator () const noexcept
 Returns the underlying frame cursor.
 
constexpr symbol_resolver_ref resolver () const noexcept
 Returns the symbol resolver handle.
 
constexpr symbol_resolution_context & symbol_context () const noexcept RELOCO_LIFETIMEBOUND
 
constexpr uint32_t max_depth () const noexcept
 Returns the maximum frame depth.
 

Detailed Description

Formattable view rendering a remote backtrace.

Constructor & Destructor Documentation

◆ remote_backtrace_view()

constexpr microfmt::remote_backtrace_view::remote_backtrace_view ( frame_pointer_iterator  iter,
symbol_resolver_ref  resolver,
symbol_resolution_context &symbol_context  RELOCO_LIFETIMEBOUND,
uint32_t  max_depth = 16 
)
inlineconstexprnoexcept

Constructs a backtrace view.

Parameters
iterCursor over the frame chain.
resolverSymbol resolver for frame PCs.
symbol_contextCaller-owned symbol-resolution scratch and state.
max_depthMaximum number of frames to render.

Member Function Documentation

◆ iterator()

constexpr frame_pointer_iterator microfmt::remote_backtrace_view::iterator ( ) const
inlineconstexprnoexcept

Returns the underlying frame cursor.

Returns
A copy of the frame_pointer_iterator.

◆ max_depth()

constexpr uint32_t microfmt::remote_backtrace_view::max_depth ( ) const
inlineconstexprnoexcept

Returns the maximum frame depth.

Returns
Frame render limit.

◆ resolver()

constexpr symbol_resolver_ref microfmt::remote_backtrace_view::resolver ( ) const
inlineconstexprnoexcept

Returns the symbol resolver handle.

Returns
Bound symbol_resolver_ref.

◆ symbol_context()

constexpr symbol_resolution_context & microfmt::remote_backtrace_view::symbol_context ( ) const
inlineconstexprnoexcept

The documentation for this class was generated from the following file: