std::filesy...lative_path(3)

💖 NAME 💖

std::filesy...lative_path(3) — that’s the manual page name, bestie — and it’s from the C++ Standard Libary. The NAME situation is literally:

std::filesystem::path::relative_path - std::filesystem::path::relative_path

Yes, it’s giving iconic repetition. 💅

✨ Synopsis ✨

path relative_path() const;  (since C++17)

This is the public member function that returns the path relative to root-path — like, a pathname composed of every generic-format component of *this after root-path. If *this is an empty path, it returns an empty path. Clean, simple, slay.

🎀 Parameters 🎀

(none) — she takes no arguments. Low-maintenance icon behavior.

🌸 Return value 🌸

Path relative to the root path. That’s the whole vibe.

🦋 Exceptions 🦋

May throw implementation-defined exceptions. So yes, exceptions can happen, and exactly which ones is implementation-defined — not me guessing, fr fr. 🙈

🔥 Example 🔥

// Run this code

#include <filesystem>
#include <iostream>
namespace fs = std::filesystem;

int main()
{
    fs::path p = fs::current_path();

    std::cout << "The current path " << p << " decomposes into:\n"
              << "root-path " << p.root_path() << '\n'
              << "relative path " << p.relative_path() << '\n';
}

Possible output:

The current path "C:\Users\abcdef\Local Settings\temp" decomposes into:
root-path "C:\"
relative path "Users\abcdef\Local Settings\temp"

👑 See also 👑

• root_name — returns the root-name of the path, if present (public member function)
• root_directory — returns the root directory of the path, if present (public member function)
• root_path — returns the root path of the path, if present (public member function)

Okay that’s the whole page, bestie! Cute sign-off with the source/version/date details: http://cppreference.com, 2024.06.10, and the page name std::filesy...lative_path(3) — periodt. 💖✨