Documentation

Overview

    Package iterator provides support for standard Google API iterators. See https://github.com/GoogleCloudPlatform/gcloud-golang/wiki/Iterator-Guidelines.

    Example
    Output:
    
    2 3 5 7 11 13 17 19
    
    Example (PageLoop)

      This example demonstrates how to use a Pager to page through an iterator in a loop.

      Output:
      
      Page 0: [2 3 5 7 11]
      Page 1: [13 17 19 23 29]
      Page 2: [31 37 41]
      
      Example (PageToken)

        The example demonstrates how to use a Pager to request a page from a given token.

        Output:
        
        Primes: [1361 1367 1373 1381 1399]
        Token:  "1400"
        
        Example (ServerPages)

          This example demonstrates how to get exactly the items in the buffer, without triggering an extra RPC.

          Output:
          
          [2 3 5 7 11 13 17 19]
          
          Example (WebHandler)

            This example demonstrates how to use Pager to support pagination on a web site.

            Output:
            
            

            Index

            Examples

            Constants

            This section is empty.

            Variables

            View Source
            var Done = errors.New("no more items in iterator")

              Done is returned by an iterator's Next method when the iteration is complete; when there are no more items to return.

              View Source
              var NewPageInfo = newPageInfo

                NewPageInfo exposes internals for iterator implementations. It is not a stable interface.

                Functions

                This section is empty.

                Types

                type PageInfo

                type PageInfo struct {
                	// Token is the token used to retrieve the next page of items from the
                	// API. You may set Token immediately after creating an iterator to
                	// begin iteration at a particular point. If Token is the empty string,
                	// the iterator will begin with the first eligible item.
                	//
                	// The result of setting Token after the first call to Next is undefined.
                	//
                	// After the underlying API method is called to retrieve a page of items,
                	// Token is set to the next-page token in the response.
                	Token string
                
                	// MaxSize is the maximum number of items returned by a call to the API.
                	// Set MaxSize as a hint to optimize the buffering behavior of the iterator.
                	// If zero, the page size is determined by the underlying service.
                	//
                	// Use Pager to retrieve a page of a specific, exact size.
                	MaxSize int
                	// contains filtered or unexported fields
                }

                  PageInfo contains information about an iterator's paging state.

                  func (*PageInfo) Remaining

                  func (pi *PageInfo) Remaining() int

                    Remaining returns the number of items available before the iterator makes another API call.

                    type Pageable

                    type Pageable interface {
                    	// PageInfo returns paging information associated with the iterator.
                    	PageInfo() *PageInfo
                    }

                      Pageable is implemented by iterators that support paging.

                      type Pager

                      type Pager struct {
                      	// contains filtered or unexported fields
                      }

                        Pager supports retrieving iterator items a page at a time.

                        func NewPager

                        func NewPager(iter Pageable, pageSize int, pageToken string) *Pager

                          NewPager returns a pager that uses iter. Calls to its NextPage method will obtain exactly pageSize items, unless fewer remain. The pageToken argument indicates where to start the iteration. Pass the empty string to start at the beginning, or pass a token retrieved from a call to Pager.NextPage.

                          If you use an iterator with a Pager, you must not call Next on the iterator.

                          func (*Pager) NextPage

                          func (p *Pager) NextPage(slicep interface{}) (nextPageToken string, err error)

                            NextPage retrieves a sequence of items from the iterator and appends them to slicep, which must be a pointer to a slice of the iterator's item type. Exactly p.pageSize items will be appended, unless fewer remain.

                            The first return value is the page token to use for the next page of items. If empty, there are no more pages. Aside from checking for the end of the iteration, the returned page token is only needed if the iteration is to be resumed a later time, in another context (possibly another process).

                            The second return value is non-nil if an error occurred. It will never be the special iterator sentinel value Done. To recognize the end of the iteration, compare nextPageToken to the empty string.

                            It is possible for NextPage to return a single zero-length page along with an empty page token when there are no more items in the iteration.

                            Source Files

                            Directories

                            Path Synopsis
                            Package testing provides support functions for testing iterators conforming to the standard pattern.
                            Package testing provides support functions for testing iterators conforming to the standard pattern.