Standard library header <stacktrace>

< cpp‎ | header

This header is part of the general utility library.



representation of an evaluation in a stacktrace
(class) [edit]
approximate representation of an invocation sequence consists of stacktrace entries
(class template) [edit]
hash support for std::stacktrace_entry
(class template specialization) [edit]
hash support for std::basic_stacktrace
(class template specialization) [edit]
Forward declarations
Defined in header <functional>
hash function object
(class template) [edit]


specializes the std::swap algorithm
(function template) [edit]
returns a string with a description of the stacktrace_entry
(function) [edit]
returns a string with a description of the basic_stacktrace
(function template) [edit]
performs stream output of stacktrace_entry
(function template) [edit]
performs stream output of basic_stracktrace
(function template) [edit]

[edit] Synopsis

namespace std {
  // class stacktrace_entry
  class stacktrace_entry;
  // class template basic_stacktrace
  template<class Allocator>
    class basic_stacktrace;
  // basic_stacktrace typedef names
  using stacktrace = basic_stacktrace<allocator<stacktrace_entry>>;
  // non-member functions
  template<class Allocator>
    void swap(basic_stacktrace<Allocator>& a, basic_stacktrace<Allocator>& b)
  string to_string(const stacktrace_entry& f);
  template<class Allocator>
    string to_string(const basic_stacktrace<Allocator>& st);
  template<class CharT, class traits>
    basic_ostream<CharT, traits>&
      operator<<(basic_ostream<CharT, traits>& os, const stacktrace_entry& f);
  template<class CharT, class Traits, class Allocator>
    basic_ostream<CharT, traits>&
      operator<<(basic_ostream<CharT, Traits>& os, const basic_stacktrace<Allocator>& st);
  namespace pmr {
    using stacktrace = std::basic_stacktrace<polymorphic_allocator<stacktrace_entry>>;
  // hash support
  template<class T> struct hash;
  template<> struct hash<stacktrace_entry>;
  template<class Allocator> struct hash<basic_stacktrace<Allocator>>;

[edit] Class std::stacktrace_entry

namespace std {
  class stacktrace_entry {
    using native_handle_type = /* implementation-defined */;
    // constructors
    constexpr stacktrace_entry() noexcept;
    constexpr stacktrace_entry(const stacktrace_entry& other) noexcept;
    constexpr stacktrace_entry& operator=(const stacktrace_entry& other) noexcept;
    // observers
    constexpr native_handle_type native_handle() const noexcept;
    constexpr explicit operator bool() const noexcept;
    // query
    string description() const;
    string source_file() const;
    uint_least32_t source_line() const;
    // comparison
    friend constexpr bool operator==(const stacktrace_entry& x,
                                     const stacktrace_entry& y) noexcept;
    friend constexpr strong_ordering operator<=>(const stacktrace_entry& x,
                                                 const stacktrace_entry& y) noexcept;

[edit] Class template std::basic_stacktrace

namespace std {
  template<class Allocator>
  class basic_stacktrace {
    using value_type = stacktrace_entry;
    using const_reference = const value_type&;
    using reference = value_type&;
    using const_iterator = /* implementation-defined */;
    using iterator = const_iterator;
    using reverse_iterator = std::reverse_iterator<iterator>;
    using const_reverse_iterator = std::reverse_iterator<const_iterator>;
    using difference_type = /* implementation-defined */;
    using size_type = /* implementation-defined */;
    using allocator_type = Allocator;
    // creation and assignment
    static basic_stacktrace
      current(const allocator_type& alloc = allocator_type()) noexcept;
    static basic_stacktrace
      current(size_type skip, const allocator_type& alloc = allocator_type()) noexcept;
    static basic_stacktrace
      current(size_type skip, size_type max_depth,
              const allocator_type& alloc = allocator_type()) noexcept;
    basic_stacktrace() noexcept(is_nothrow_default_constructible_v<allocator_type>);
    explicit basic_stacktrace(const allocator_type& alloc) noexcept;
    basic_stacktrace(const basic_stacktrace& other);
    basic_stacktrace(basic_stacktrace&& other) noexcept;
    basic_stacktrace(const basic_stacktrace& other, const allocator_type& alloc);
    basic_stacktrace(basic_stacktrace&& other, const allocator_type& alloc);
    basic_stacktrace& operator=(const basic_stacktrace& other);
    basic_stacktrace& operator=(basic_stacktrace&& other) noexcept(
        allocator_traits<Allocator>::propagate_on_container_move_assignment::value ||
    // observers
    allocator_type get_allocator() const noexcept;
    const_iterator begin() const noexcept;
    const_iterator end() const noexcept;
    const_reverse_iterator rbegin() const noexcept;
    const_reverse_iterator rend() const noexcept;
    const_iterator cbegin() const noexcept;
    const_iterator cend() const noexcept;
    const_reverse_iterator crbegin() const noexcept;
    const_reverse_iterator crend() const noexcept;
    [[nodiscard]] bool empty() const noexcept;
    size_type size() const noexcept;
    size_type max_size() const noexcept;
    const_reference operator[](size_type) const;
    const_reference at(size_type) const;
    // comparisons
    template<class Allocator2>
    friend bool operator==(const basic_stacktrace& x,
                           const basic_stacktrace<Allocator2>& y) noexcept;
    template<class Allocator2>
    friend strong_ordering operator<=>(const basic_stacktrace& x,
                                       const basic_stacktrace<Allocator2>& y) noexcept;
    // modifiers
    void swap(basic_stacktrace& other)
      noexcept(allocator_traits<Allocator>::propagate_on_container_swap::value ||
    vector<value_type, allocator_type> frames_;         // exposition only