PagedCollection

public class PagedCollection<SingleElement> where SingleElement : Decodable, SingleElement : Encodable

A collection that fetches paged results in a lazy fashion.

Properties


                    
                    
                    Element

Undocumented

Declaration

Swift

public typealias Element = [SingleElement]

items
Returns the current running list of items.
Declaration
Swift

public var items: Element? { get }
pageItems
Returns the subset of items that corresponds to the current page.
Declaration
Swift

public var pageItems: Element? { get }
underestimatedCount
Returns the count of items that have been retrieved so far. There may be additional results, not yet fetched.
Declaration
Swift

public var underestimatedCount: Int { get }
isExhausted
Returns true if there are no more results to fetch.
Declaration
Swift

public var isExhausted: Bool { get }


                    
                    
                    PagedItemSyncIterator

Undocumented

Declaration

Swift

public struct PagedItemSyncIterator : Sequence, IteratorProtocol

syncIterator
Returns a iterator to retrieve paged items one at a time.
Declaration
Swift

public var syncIterator: PagedItemSyncIterator { get }

Initializers


                    
                    
                    init(client:request:context:data:codingKeys:decoder:)

<#Description#>

Throws

AzureErrors.sdk thrown if no data is returned from the server.

Declaration

Swift

public init(
    client: PageableClient,
    request: HTTPRequest,
    context: PipelineContext,
    data: Data?,
    codingKeys: PagedCodingKeys? = nil,
    decoder: JSONDecoder? = nil
) throws

Parameters

`client`	The `PageableClient` used to make calls for follow-up pages.
`request`	The original `HTTPRequest` used to make the call.
`context`	A `PipelineContext` object that will be used for follow-up page requests.
`data`	The `Data` corresponding to the first page results.
`codingKeys`	An optional set of `PagedCodingKeys` used to decode the paged results.
`decoder`	An optional `JSONDecoder` for decoding special types.

Public Methods

nextPage(completionHandler:)
Retrieves the next page of results asynchronously.
Declaration
Swift

public func nextPage(completionHandler: @escaping Continuation<Element>)


                    
                    
                    nextPage()

Asynchronous

Undocumented

Declaration

Swift

public func nextPage() async throws -> [SingleElement]

nextItem(completionHandler:)
Retrieves the next item in the collection, automatically fetching new pages when needed.
Declaration
Swift

public func nextItem(completionHandler: @escaping Continuation<SingleElement>)


                    
                    
                    nextItem()

Asynchronous

Undocumented

Declaration

Swift

public func nextItem() async throws -> SingleElement


                    
                    
                    forEachPage(progressHandler:)

Undocumented

Declaration

Swift

public func forEachPage(progressHandler: @escaping (Element) -> Bool)


                    
                    
                    forEachItem(progressHandler:)

Undocumented

Declaration

Swift

public func forEachItem(progressHandler: @escaping (SingleElement) -> Bool)