Tgstation.Server.Client.PaginatedClient Class Reference

Client that deals with getting paginated results. More...

Inheritance diagram for Tgstation.Server.Client.PaginatedClient:

Public Member Functions
	PaginatedClient (IApiClient apiClient)
	Initializes a new instance of the PaginatedClient class.

Protected Member Functions
async ValueTask< List< TModel > >	ReadPaged< TModel > (PaginationSettings? paginationSettings, string route, long? instanceId, CancellationToken cancellationToken)
	Reads a given route with paged results.

Properties
IApiClient	ApiClient [get]
	The IApiClient for the PaginatedClient.

Detailed Description

Client that deals with getting paginated results.

Definition at line 16 of file PaginatedClient.cs.

Constructor & Destructor Documentation

PaginatedClient()

Tgstation.Server.Client.PaginatedClient.PaginatedClient

(

IApiClient

apiClient

)

Initializes a new instance of the PaginatedClient class.

Parameters

apiClient

The value of ApiClient.

Definition at line 27 of file PaginatedClient.cs.

        {
            ApiClient = apiClient ?? throw new ArgumentNullException(nameof(apiClient));
        }

Member Function Documentation

ReadPaged< TModel >()

async ValueTask< List< TModel > > Tgstation.Server.Client.PaginatedClient.ReadPaged< TModel > ( PaginationSettings?  paginationSettings, string  route, long?  instanceId, CancellationToken  cancellationToken  )

protected

Reads a given route with paged results.

Template Parameters

TModel

The Type of result model.

Parameters

paginationSettings	The PaginationSettings if any.
route	The route.
instanceId	The optional Instance EntityId.Id.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in an List<T> of the paginated TModel s.

Definition at line 41 of file PaginatedClient.cs.

        {
            if (route == null)
                throw new ArgumentNullException(nameof(route));
 
            var routeFormatter = $"{route}?page={{0}}";
            var currentPage = 1;
            if (paginationSettings != null)
            {
                if (paginationSettings.RetrieveCount == 0)
                    return new List<TModel>(); // that was easy
                else if (paginationSettings.RetrieveCount < 0)
                    throw new ArgumentOutOfRangeException(nameof(paginationSettings), "RetrieveCount cannot be less than 0!");
 
                int? pageSize = null;
                if (paginationSettings.PageSize.HasValue)
                {
                    // pagesize validates itself on first request
                    pageSize = paginationSettings.PageSize.Value;
                    routeFormatter += $"&pageSize={pageSize}";
                }
 
                if (paginationSettings.Offset.HasValue)
                {
                    if (paginationSettings.Offset.Value < 0)
                        throw new ArgumentOutOfRangeException(nameof(paginationSettings), "Offset cannot be less than 0!");
 
                    pageSize ??= paginationSettings.Offset.Value;
                    currentPage = (paginationSettings.Offset.Value / pageSize.Value) + 1;
                }
            }
 
            ValueTask<PaginatedResponse<TModel>> GetPage() => instanceId.HasValue
                ? ApiClient.Read<PaginatedResponse<TModel>>(
                    String.Format(CultureInfo.InvariantCulture, routeFormatter, currentPage),
                    instanceId.Value,
                    cancellationToken)
                : ApiClient.Read<PaginatedResponse<TModel>>(
                    String.Format(CultureInfo.InvariantCulture, routeFormatter, currentPage),
                    cancellationToken);
 
            var firstPage = await GetPage().ConfigureAwait(false);
 
            var totalAvailable = firstPage.TotalPages * firstPage.PageSize;
            var maximumItems = paginationSettings?.RetrieveCount.HasValue == true
                ? Math.Min(paginationSettings.RetrieveCount!.Value, totalAvailable)
                : totalAvailable;
 
            var results = new List<TModel>(maximumItems);
            var currentResults = firstPage;
            do
            {
                // check if first page
                if (currentPage > 1)
                    currentResults = await GetPage().ConfigureAwait(false);
 
                if (currentResults.Content == null)
                    throw new ApiConflictException("Paginated results missing content!");
 
                IEnumerable<TModel> rangeToAdd = currentResults.Content;
                if (paginationSettings?.Offset.HasValue == true)
                {
                    rangeToAdd = rangeToAdd
                        .Skip(paginationSettings.Offset!.Value % currentResults.PageSize);
                }
 
                var itemsAvailableInPage = rangeToAdd.Count();
                var itemsStillRequired = maximumItems - results.Count;
                if (itemsAvailableInPage > itemsStillRequired)
                    rangeToAdd = rangeToAdd
                        .Take(itemsStillRequired);
 
                results.AddRange(rangeToAdd);
                ++currentPage;
            }
            while (results.Count < maximumItems && currentPage <= currentResults.TotalPages);
 
            return results;
        }

References Tgstation.Server.Client.PaginationSettings.Offset, Tgstation.Server.Api.Models.Response.PaginatedResponse< TModel >.PageSize, Tgstation.Server.Client.PaginationSettings.PageSize, and Tgstation.Server.Client.PaginationSettings.RetrieveCount.

Property Documentation

ApiClient

IApiClient Tgstation.Server.Client.PaginatedClient.ApiClient

getprotected

The IApiClient for the PaginatedClient.

Definition at line 21 of file PaginatedClient.cs.

{ get; }

---

The documentation for this class was generated from the following file:

• src/Tgstation.Server.Client/PaginatedClient.cs