osu/osu.Game/Online/API/Requests/PaginationParameters.cs

// Copyright (c) ppy Pty Ltd <contact@ppy.sh>. Licensed under the MIT Licence.
// See the LICENCE file in the repository root for full licence text.

#nullable disable

namespace osu.Game.Online.API.Requests
{
    /// <summary>
    /// Represents a pagination data used for <see cref="PaginatedAPIRequest{T}"/>.
    /// </summary>
    public readonly struct PaginationParameters
    {
        /// <summary>
        /// The starting point of the request.
        /// </summary>
        public int Offset { get; }

        /// <summary>
        /// The maximum number of items to return in this request.
        /// </summary>
        public int Limit { get; }

        public PaginationParameters(int offset, int limit)
        {
            Offset = offset;
            Limit = limit;
        }

        public PaginationParameters(int limit)
            : this(0, limit)
        {
        }

        /// <summary>
        /// Returns a <see cref="PaginationParameters"/> of the next number of items defined by <paramref name="limit"/> after this.
        /// </summary>
        /// <param name="limit">The limit of the next pagination.</param>
        public PaginationParameters TakeNext(int limit) => new PaginationParameters(Offset + Limit, limit);
    }
}