File: handwritten_paginators.go

package info (click to toggle)
golang-github-aws-aws-sdk-go-v2 1.24.1-2~bpo12%2B1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm-backports
  • size: 554,032 kB
  • sloc: java: 15,941; makefile: 419; sh: 175
file content (94 lines) | stat: -rw-r--r-- 2,694 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
package kinesis

import (
	"context"
	"fmt"

	"github.com/aws/aws-sdk-go-v2/aws"
)

// DescribeStreamPaginatorOptions is the paginator options for DescribeStream
type DescribeStreamPaginatorOptions struct {
	// (Optional) The maximum number of shards to return in a single call
	Limit *int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

// DescribeStreamPaginator is a paginator for DescribeStream
type DescribeStreamPaginator struct {
	options               DescribeStreamPaginatorOptions
	client                DescribeStreamAPIClient
	params                *DescribeStreamInput
	firstPage             bool
	exclusiveStartShardID *string
	isTruncated           *bool
}

// NewDescribeStreamPaginator returns a new DescribeStreamPaginator
func NewDescribeStreamPaginator(client DescribeStreamAPIClient, params *DescribeStreamInput, optFns ...func(*DescribeStreamPaginatorOptions)) *DescribeStreamPaginator {
	if params == nil {
		params = &DescribeStreamInput{}
	}

	options := DescribeStreamPaginatorOptions{}
	options.Limit = params.Limit

	for _, fn := range optFns {
		fn(&options)
	}

	return &DescribeStreamPaginator{
		options:               options,
		client:                client,
		params:                params,
		firstPage:             true,
		exclusiveStartShardID: params.ExclusiveStartShardId,
	}
}

// HasMorePages returns a boolean indicating whether more pages are available
func (p *DescribeStreamPaginator) HasMorePages() bool {
	return p.firstPage || *p.isTruncated
}

// NextPage retrieves the next DescribeStream page.
func (p *DescribeStreamPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStreamOutput, error) {
	if !p.HasMorePages() {
		return nil, fmt.Errorf("no more pages available")
	}

	params := *p.params
	params.ExclusiveStartShardId = p.exclusiveStartShardID

	var limit *int32
	if *p.options.Limit > 0 {
		limit = p.options.Limit
	}
	params.Limit = limit

	result, err := p.client.DescribeStream(ctx, &params, optFns...)
	if err != nil {
		return nil, err
	}
	p.firstPage = false

	prevToken := p.exclusiveStartShardID
	p.isTruncated = result.StreamDescription.HasMoreShards
	p.exclusiveStartShardID = nil
	if *result.StreamDescription.HasMoreShards {
		shardsLength := len(result.StreamDescription.Shards)
		p.exclusiveStartShardID = result.StreamDescription.Shards[shardsLength-1].ShardId
	}

	if p.options.StopOnDuplicateToken &&
		prevToken != nil &&
		p.exclusiveStartShardID != nil &&
		*prevToken == *p.exclusiveStartShardID {
		p.isTruncated = aws.Bool(false)
	}

	return result, nil
}