Errors.h

/*
 * Copyright 2022-2024 Dmitry Ivanov
 *
 * This file is part of libquentier
 *
 * libquentier is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as published by
 * the Free Software Foundation, version 3 of the License.
 *
 * libquentier is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <quentier/utility/Linkage.h>

#include <QtGlobal>

#include <optional>
#include <variant>

namespace quentier::synchronization {

struct QUENTIER_EXPORT RateLimitReachedError
{
    std::optional<qint32> rateLimitDurationSec;
};

[[nodiscard]] QUENTIER_EXPORT bool operator==(
    const RateLimitReachedError & lhs,
    const RateLimitReachedError & rhs) noexcept;

[[nodiscard]] QUENTIER_EXPORT bool operator!=(
    const RateLimitReachedError & lhs,
    const RateLimitReachedError & rhs) noexcept;

struct QUENTIER_EXPORT AuthenticationExpiredError
{};

[[nodiscard]] QUENTIER_EXPORT bool operator==(
    const AuthenticationExpiredError & lhs,
    const AuthenticationExpiredError & rhs) noexcept;

[[nodiscard]] QUENTIER_EXPORT bool operator!=(
    const AuthenticationExpiredError & lhs,
    const AuthenticationExpiredError & rhs) noexcept;

using StopSynchronizationError = std::variant<
    RateLimitReachedError, AuthenticationExpiredError, std::monostate>;

} // namespace quentier::synchronization