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

Symbolic view of a remote function / code pointer. More...

#include <remote_diagnostics.hpp>

Public Member Functions

constexpr remote_fn_ptr () noexcept=default
 Constructs an empty (null) view.
 
constexpr remote_fn_ptr (uintptr_t addr, symbol_resolver_ref resolver, symbol_resolution_context &context RELOCO_LIFETIMEBOUND) noexcept
 Constructs a view over a remote code address.
 
constexpr uintptr_t address () const noexcept
 Returns the code address.
 
constexpr bool is_null () const noexcept
 Reports whether the address is null.
 
constexpr symbol_resolver_ref resolver () const noexcept
 Returns the symbol resolver handle.
 
constexpr symbol_resolution_context & context () const noexcept RELOCO_LIFETIMEBOUND
 Returns caller-owned symbol-resolution temporaries.
 

Detailed Description

Symbolic view of a remote function / code pointer.

Renders (null), a raw 0x.. address, or a resolved symbol depending on the format mode and resolver availability.

Constructor & Destructor Documentation

◆ remote_fn_ptr() [1/2]

constexpr microfmt::remote_fn_ptr::remote_fn_ptr ( )
constexprdefaultnoexcept

Constructs an empty (null) view.

◆ remote_fn_ptr() [2/2]

constexpr microfmt::remote_fn_ptr::remote_fn_ptr ( uintptr_t  addr,
symbol_resolver_ref  resolver,
symbol_resolution_context &context  RELOCO_LIFETIMEBOUND 
)
inlineconstexprnoexcept

Constructs a view over a remote code address.

Parameters
addrCode address to render.
resolverOptional symbol resolver.
contextCaller-owned symbol-resolution temporaries.

Member Function Documentation

◆ address()

constexpr uintptr_t microfmt::remote_fn_ptr::address ( ) const
inlineconstexprnoexcept

Returns the code address.

Returns
Absolute address, or 0 when null.

◆ context()

constexpr symbol_resolution_context & microfmt::remote_fn_ptr::context ( ) const
inlineconstexprnoexcept

Returns caller-owned symbol-resolution temporaries.

◆ is_null()

constexpr bool microfmt::remote_fn_ptr::is_null ( ) const
inlineconstexprnoexcept

Reports whether the address is null.

Returns
true when the pointer is null.

◆ resolver()

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

Returns the symbol resolver handle.

Returns
Bound symbol_resolver_ref.

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