std::shared...:operator->(3)

💅 std::shared...:operator->(3) — C++ Standard Libary 💅

okay so welcome to the page for std::shared_ptr’s dereference besties 💖 this one is about std::shared_ptr::operator* and std::shared_ptr::operator->, and yes, both of them are since C++11. let’s get into it, no cap 🫶

---

✨ NAME ✨

std::shared_ptr::operator*,std::shared_ptr::operator-> - std::shared_ptr::operator*,std::shared_ptr::operator->

---

🌸 Synopsis 🌸

both are const noexcept, and both are since C++11:

T& operator*() const noexcept;  (1) (since C++11)
T* operator->() const noexcept; (2) (since C++11)

these bad boys dereference the stored pointer. the behavior is undefined if the stored pointer is null 😭 not a vibe, not a maybe — actual undefined behavior, bestie. do not play with that.

---

🎀 Parameters 🎀

(none) — literally zero arguments. nothing. nada. the void is empty and we love that for them ✨

---

💖 Return value 💖

1. the result of dereferencing the stored pointer, i.e. *get().
2. the stored pointer, i.e. get().

✨ Remarks ✨

• when T is an array type or (possibly cv-qualified) (since C++17) void, it is unspecified whether function (1) is declared. if it is declared, it is unspecified what its return type is, except that the declaration (although not necessarily the definition) of the function shall be well formed. this makes it possible to instantiate std::shared_ptr<void> 👀
• when T is an array type, it is unspecified whether function (2) is declared. if it is declared, it is unspecified what its return type (since C++17) is, except that the declaration of the function shall be well-formed.

---

🍓 Example 🍓

run it: // Run this code

#include <iostream>
#include <memory>

struct Foo
{
    Foo(int in) : a(in) {}
    void print() const
    {
        std::cout << "a = " << a << '\n';
    }
    int a;
};

int main()
{
    auto ptr = std::make_shared<Foo>(10);
    ptr->print();
    (*ptr).print();
}

🌈 Output 🌈

a = 10
a = 10

---

👑 See also 👑

• get — returns the stored pointer (public member function)

---

mwah 💋 this one’s from http://cppreference.com, dated 2024.06.10, and the page is std::shared...:operator->(3). periodt. 🫶