TimeSpan.h

Go to the documentation of this file.

/*
 * MIT License
 *
 * Copyright (c) 2025 nfx
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

 
#pragma once
 
#include <chrono>
#include <compare>
#include <cstdint>
#include <format>
#include <optional>
#include <string>
#include <string_view>
 
namespace nfx::time
{
    //=====================================================================
    // TimeSpan class
    //=====================================================================

    class TimeSpan final
    {
    public:
        //----------------------------------------------
        // Construction
        //----------------------------------------------

        explicit inline constexpr TimeSpan( std::int64_t ticks = 0 ) noexcept;

        explicit inline constexpr TimeSpan( std::chrono::system_clock::duration duration ) noexcept;

        explicit TimeSpan( std::string_view iso8601String );

        TimeSpan( const TimeSpan& ) = default;

        TimeSpan( TimeSpan&& ) noexcept = default;
 
        //----------------------------------------------
        // Destruction
        //----------------------------------------------

        ~TimeSpan() = default;
 
        //----------------------------------------------
        // Assignment
        //----------------------------------------------

        TimeSpan& operator=( const TimeSpan& ) = default;

        TimeSpan& operator=( TimeSpan&& ) noexcept = default;
 
        //----------------------------------------------
        // Comparison operators
        //----------------------------------------------

        inline constexpr std::strong_ordering operator<=>( const TimeSpan& other ) const noexcept;

        inline constexpr bool operator==( const TimeSpan& other ) const noexcept;
 
        //----------------------------------------------
        // Arithmetic operators
        //----------------------------------------------

        inline constexpr TimeSpan operator+( const TimeSpan& other ) const noexcept;

        inline constexpr TimeSpan operator-( const TimeSpan& other ) const noexcept;

        inline constexpr TimeSpan operator-() const noexcept;

        inline constexpr TimeSpan& operator+=( const TimeSpan& other ) noexcept;

        inline constexpr TimeSpan& operator-=( const TimeSpan& other ) noexcept;

        inline TimeSpan operator*( double multiplier ) const noexcept;

        inline TimeSpan operator/( double divisor ) const noexcept;

        inline double operator/( const TimeSpan& other ) const noexcept;

        friend inline TimeSpan operator*( double multiplier, const TimeSpan& ts ) noexcept;
 
        //----------------------------------------------
        // Property accessors
        //----------------------------------------------

        [[nodiscard]] inline double days() const noexcept;

        [[nodiscard]] inline double hours() const noexcept;

        [[nodiscard]] inline double minutes() const noexcept;

        [[nodiscard]] inline double seconds() const noexcept;

        [[nodiscard]] inline double milliseconds() const noexcept;

        [[nodiscard]] inline double microseconds() const noexcept;

        [[nodiscard]] inline double nanoseconds() const noexcept;

        [[nodiscard]] inline constexpr std::int64_t ticks() const noexcept;
 
        //----------------------------------------------
        // String formatting
        //----------------------------------------------

        [[nodiscard]] std::string toString() const;
 
        //----------------------------------------------
        // String parsing
        //----------------------------------------------

        [[nodiscard]] static bool fromString( std::string_view iso8601DurationString, TimeSpan& result ) noexcept;

        [[nodiscard]] static std::optional<TimeSpan> fromString( std::string_view iso8601DurationString ) noexcept;
 
        //----------------------------------------------
        // std::chrono interoperability
        //----------------------------------------------

        [[nodiscard]] std::chrono::system_clock::duration toChrono() const noexcept;

        [[nodiscard]] static TimeSpan fromChrono( const std::chrono::system_clock::duration& duration ) noexcept;
 
        //----------------------------------------------
        // Static factory methods
        //----------------------------------------------

        [[nodiscard]] inline static constexpr TimeSpan fromDays( double days ) noexcept;

        [[nodiscard]] inline static constexpr TimeSpan fromHours( double hours ) noexcept;

        [[nodiscard]] inline static constexpr TimeSpan fromMinutes( double minutes ) noexcept;

        [[nodiscard]] inline static constexpr TimeSpan fromSeconds( double seconds ) noexcept;

        [[nodiscard]] inline static constexpr TimeSpan fromMilliseconds( double milliseconds ) noexcept;

        [[nodiscard]] inline static constexpr TimeSpan fromMicroseconds( double microseconds ) noexcept;

        [[nodiscard]] inline static constexpr TimeSpan fromTicks( double ticks ) noexcept;
 
    private:
        std::int64_t m_ticks;
    };
} // namespace nfx::time
 
#include "nfx/detail/datetime/TimeSpan.inl"