Class PagedResponse<TResponse>

Namespace

Trellis.Asp

Assembly

Trellis.Asp.dll

JSON envelope wrapping a single page of items and its cursor links.

public sealed record PagedResponse<TResponse> : IEquatable<PagedResponse<TResponse>>

Type Parameters

TResponse

Inheritance

object

PagedResponse<TResponse>

Implements

IEquatable<PagedResponse<TResponse>>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

MaybeExtensions.AsMaybe<T>(T)

MaybeExtensions.ToResult<TValue>(TValue)

NullableExtensions.ToResult<T>(T?, Func<Error>)

NullableExtensions.ToResult<T>(T?, Error)

AggregateTestMutator.ClearMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>)

AggregateTestMutator.SetMaybeField<TEntity, TValue>(TEntity, Expression<Func<TEntity, Maybe<TValue>>>, TValue?)

Constructors

PagedResponse(IReadOnlyList<TResponse>, PageLink?, PageLink?, int, int, int, bool)

JSON envelope wrapping a single page of items and its cursor links.

public PagedResponse(IReadOnlyList<TResponse> Items, PageLink? Next, PageLink? Previous, int RequestedLimit, int AppliedLimit, int DeliveredCount, bool WasCapped)

Parameters

Items IReadOnlyList<TResponse>

Next PageLink

Previous PageLink

RequestedLimit int

AppliedLimit int

DeliveredCount int

WasCapped bool

Properties

AppliedLimit

public int AppliedLimit { get; init; }

Property Value

int

DeliveredCount

public int DeliveredCount { get; init; }

Property Value

int

Items

public IReadOnlyList<TResponse> Items { get; init; }

Property Value

IReadOnlyList<TResponse>

Next

public PageLink? Next { get; init; }

Property Value

PageLink

Previous

public PageLink? Previous { get; init; }

Property Value

PageLink

RequestedLimit

public int RequestedLimit { get; init; }

Property Value

int

WasCapped

public bool WasCapped { get; init; }

Property Value

bool