aws_sdk_s3/operation/list_buckets/
paginator.rs

Help
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Paginator for [`ListBuckets`](crate::operation::list_buckets::ListBuckets)
3pub struct ListBucketsPaginator {
4    handle: std::sync::Arc<crate::client::Handle>,
5    builder: crate::operation::list_buckets::builders::ListBucketsInputBuilder,
6    stop_on_duplicate_token: bool,
7}
8
9impl ListBucketsPaginator {
10    /// Create a new paginator-wrapper
11    pub(crate) fn new(
12        handle: std::sync::Arc<crate::client::Handle>,
13        builder: crate::operation::list_buckets::builders::ListBucketsInputBuilder,
14    ) -> Self {
15        Self {
16            handle,
17            builder,
18            stop_on_duplicate_token: true,
19        }
20    }
21
22    /// Set the page size
23    ///
24    /// _Note: this method will override any previously set value for `max_buckets`_
25    pub fn page_size(mut self, limit: i32) -> Self {
26        self.builder.max_buckets = ::std::option::Option::Some(limit);
27        self
28    }
29
30    /// Create a flattened paginator
31    ///
32    /// This paginator automatically flattens results using `buckets`. Queries to the underlying service
33    /// are dispatched lazily.
34    pub fn items(self) -> crate::operation::list_buckets::paginator::ListBucketsPaginatorItems {
35        crate::operation::list_buckets::paginator::ListBucketsPaginatorItems(self)
36    }
37
38    /// Stop paginating when the service returns the same pagination token twice in a row.
39    ///
40    /// Defaults to true.
41    ///
42    /// For certain operations, it may be useful to continue on duplicate token. For example,
43    /// if an operation is for tailing a log file in real-time, then continuing may be desired.
44    /// This option can be set to `false` to accommodate these use cases.
45    pub fn stop_on_duplicate_token(mut self, stop_on_duplicate_token: bool) -> Self {
46        self.stop_on_duplicate_token = stop_on_duplicate_token;
47        self
48    }
49
50    /// Create the pagination stream
51    ///
52    /// _Note:_ No requests will be dispatched until the stream is used
53    /// (e.g. with the [`.next().await`](aws_smithy_async::future::pagination_stream::PaginationStream::next) method).
54    pub fn send(
55        self,
56    ) -> ::aws_smithy_async::future::pagination_stream::PaginationStream<
57        ::std::result::Result<
58            crate::operation::list_buckets::ListBucketsOutput,
59            ::aws_smithy_runtime_api::client::result::SdkError<
60                crate::operation::list_buckets::ListBucketsError,
61                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
62            >,
63        >,
64    > {
65        // Move individual fields out of self for the borrow checker
66        let builder = self.builder;
67        let handle = self.handle;
68        let runtime_plugins = crate::operation::list_buckets::ListBuckets::operation_runtime_plugins(
69            handle.runtime_plugins.clone(),
70            &handle.conf,
71            ::std::option::Option::None,
72        )
73        .with_operation_plugin(crate::sdk_feature_tracker::paginator::PaginatorFeatureTrackerRuntimePlugin::new());
74        ::aws_smithy_async::future::pagination_stream::PaginationStream::new(::aws_smithy_async::future::pagination_stream::fn_stream::FnStream::new(
75            move |tx| {
76                ::std::boxed::Box::pin(async move {
77                    // Build the input for the first time. If required fields are missing, this is where we'll produce an early error.
78                    let mut input = match builder
79                        .build()
80                        .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)
81                    {
82                        ::std::result::Result::Ok(input) => input,
83                        ::std::result::Result::Err(e) => {
84                            let _ = tx.send(::std::result::Result::Err(e)).await;
85                            return;
86                        }
87                    };
88                    loop {
89                        let resp = crate::operation::list_buckets::ListBuckets::orchestrate(&runtime_plugins, input.clone()).await;
90                        // If the input member is None or it was an error
91                        let done = match resp {
92                            ::std::result::Result::Ok(ref resp) => {
93                                let new_token = crate::lens::reflens_list_buckets_output_output_continuation_token(resp);
94                                // Pagination is exhausted when the next token is an empty string
95                                let is_empty = new_token.map(|token| token.is_empty()).unwrap_or(true);
96                                if !is_empty && new_token == input.continuation_token.as_ref() && self.stop_on_duplicate_token {
97                                    true
98                                } else {
99                                    input.continuation_token = new_token.cloned();
100                                    is_empty
101                                }
102                            }
103                            ::std::result::Result::Err(_) => true,
104                        };
105                        if tx.send(resp).await.is_err() {
106                            // receiving end was dropped
107                            return;
108                        }
109                        if done {
110                            return;
111                        }
112                    }
113                })
114            },
115        ))
116    }
117}
118
119/// Flattened paginator for `ListBucketsPaginator`
120///
121/// This is created with [`.items()`](ListBucketsPaginator::items)
122pub struct ListBucketsPaginatorItems(ListBucketsPaginator);
123
124impl ListBucketsPaginatorItems {
125    /// Create the pagination stream
126    ///
127    /// _Note_: No requests will be dispatched until the stream is used
128    /// (e.g. with the [`.next().await`](aws_smithy_async::future::pagination_stream::PaginationStream::next) method).
129    ///
130    /// To read the entirety of the paginator, use [`.collect::<Result<Vec<_>, _>()`](aws_smithy_async::future::pagination_stream::PaginationStream::collect).
131    pub fn send(
132        self,
133    ) -> ::aws_smithy_async::future::pagination_stream::PaginationStream<
134        ::std::result::Result<
135            crate::types::Bucket,
136            ::aws_smithy_runtime_api::client::result::SdkError<
137                crate::operation::list_buckets::ListBucketsError,
138                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
139            >,
140        >,
141    > {
142        ::aws_smithy_async::future::pagination_stream::TryFlatMap::new(self.0.send())
143            .flat_map(|page| crate::lens::lens_list_buckets_output_output_buckets(page).unwrap_or_default().into_iter())
144    }
145}
aws_sdk_s3/operation/list_buckets/paginator.rs

aws_sdk_s3/operation/list_buckets/
paginator.rs
