std::chrono::year(3)

std::chrono::year(3) 🎀

okay bestie, welcome to the std::chrono::year(3) page from the C++ Standard Libary manual 💖 (yes, “Libary” is literally how the manual name is spelled in the header — iykyk). This is the whole cute little year-class situation, and we’re getting into every member, every operator, and every helper. no cap.

💖 NAME 💖

std::chrono::year — std::chrono::year

✨ Synopsis ✨

okay so she’s defined in header <chrono> and the class is literally this:

Defined in header <chrono>
class year;                 (since C++20)

The class year represents a year in the proleptic Gregorian calendar. Its range is [-32767, 32767]. That’s the whole range, bestie — no sneaky extra years hiding outside it.

year is a TriviallyCopyable StandardLayoutType. slay.

🎀 Member functions 🎀

• constructor — constructs a year (public member function)
• operator++ — increments or decrements the year (public member function)
• operator++(int) — increments or decrements the year (public member function)
• operator-- — increments or decrements the year (public member function)
• operator--(int) — increments or decrements the year (public member function)
• operator+= — adds or subtracts a number of years from a year (public member function)
• operator-= — adds or subtracts a number of years from a year (public member function)
• operator+ — applies unary operators to year (public member function)
• operator- — applies unary operators to year (public member function)
• is_leap — determines if the year is a leap year (public member function)
• operator int — retrieve the year value (public member function)
• ok — checks if the stored year value is valid (public member function)
• min [static] — returns the smallest possible year value (public static member function)
• max [static] — returns the largest possible year (public static member function)

🌈 Non-member functions 🌈

• operator==, operator<=> (C++20) — compares two year values (function)
• operator+, operator- (C++20) — performs arithmetic on years (function)
• operator<< (C++20) — outputs a year into a stream (function template)
• from_stream (C++20) — parses a year from a stream according to the provided format (function template)

🦋 Helper classes 🦋

• std::formatter<std::chrono::year> (C++20) — formatting support for year (class template specialization)
• std::hash<std::chrono::year> (C++26) — hash support for std::chrono::year (class template specialization)

🌸 Literals 🌸

Defined in inline namespace std::literals::chrono_literals

• operator""y (C++20) — a std::chrono::year literal representing a particular year (function)

mwah 💋 before you go: source/version is http://cppreference.com, the date is 2024.06.10, and this icon is the std::chrono::year(3) page. periodt. 💜