Struct CatalogSearchPagination 

pub struct CatalogSearchPagination {
    pub current_page: i32,
    pub has_next_page: bool,
    pub max_page: i32,
    pub page_count: i64,
    pub page_size: i32,
    pub token: String,
    pub total_count: i64,
    pub total_count_relation: CatalogSearchTotalCountRelation,
}

Authority-reported navigation metadata, returned only to callers requiring catalog-search-pagination and only when a supported token is present. Tokenless first-page and continuation responses omit this object; no counts are inferred from candidates. The opaque token may be retained for previous or numbered navigation even when hasNextPage is false.

Experimental. This type is part of an experimental wire-protocol surface and may change or be removed in future SDK or CLI releases.

Fields

current_page: i32

One-based page returned by the authority.

has_next_page: bool

Whether the authority token advertises a valid next target within the navigation window. Not inferred from token presence, truncated, or currentPage being less than pageCount.

max_page: i32

Navigation window ceiling ceil(1000 / pageSize), not the number of existing pages. Legal targets must not exceed this ceiling or the token’s signed pageCount.

page_count: i64

Backend-reported page count, which may exceed maxPage. Present pagination metadata always describes a multi-page result; zero- and single-page responses omit pagination. Navigation targets must also be within the signed pageCount carried by the supplied token.

page_size: i32

Page size bound to the search, equal to the effective request limit.

token: String

Opaque authority-issued pagination token. Only the runtime decodes it or changes targetPage; SDK consumers must not decode, modify or log it. It has no runtime-created expiry or cache.

total_count: i64

Backend-reported count for this response, not the number of returned candidates. Its relationship to the full query result set is unknown.

total_count_relation: CatalogSearchTotalCountRelation

The relationship of totalCount to the complete query result set is unknown; neither exactness nor a lower-bound guarantee is implied.

Trait Implementations

impl Clone for CatalogSearchPagination

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CatalogSearchPagination

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CatalogSearchPagination

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CatalogSearchPagination

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CatalogSearchPagination

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.