aws_sdk_s3/operation/list_objects_v2/
paginator.rs

Help
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Paginator for [`ListObjectsV2`](crate::operation::list_objects_v2::ListObjectsV2)
3pub struct ListObjectsV2Paginator {
4    handle: std::sync::Arc<crate::client::Handle>,
5    builder: crate::operation::list_objects_v2::builders::ListObjectsV2InputBuilder,
6    stop_on_duplicate_token: bool,
7}
8
9impl ListObjectsV2Paginator {
10    /// Create a new paginator-wrapper
11    pub(crate) fn new(
12        handle: std::sync::Arc<crate::client::Handle>,
13        builder: crate::operation::list_objects_v2::builders::ListObjectsV2InputBuilder,
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_keys`_
25    pub fn page_size(mut self, limit: i32) -> Self {
26        self.builder.max_keys = ::std::option::Option::Some(limit);
27        self
28    }
29
30    /// Stop paginating when the service returns the same pagination token twice in a row.
31    ///
32    /// Defaults to true.
33    ///
34    /// For certain operations, it may be useful to continue on duplicate token. For example,
35    /// if an operation is for tailing a log file in real-time, then continuing may be desired.
36    /// This option can be set to `false` to accommodate these use cases.
37    pub fn stop_on_duplicate_token(mut self, stop_on_duplicate_token: bool) -> Self {
38        self.stop_on_duplicate_token = stop_on_duplicate_token;
39        self
40    }
41
42    /// Create the pagination stream
43    ///
44    /// _Note:_ No requests will be dispatched until the stream is used
45    /// (e.g. with the [`.next().await`](aws_smithy_async::future::pagination_stream::PaginationStream::next) method).
46    pub fn send(
47        self,
48    ) -> ::aws_smithy_async::future::pagination_stream::PaginationStream<
49        ::std::result::Result<
50            crate::operation::list_objects_v2::ListObjectsV2Output,
51            ::aws_smithy_runtime_api::client::result::SdkError<
52                crate::operation::list_objects_v2::ListObjectsV2Error,
53                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
54            >,
55        >,
56    > {
57        // Move individual fields out of self for the borrow checker
58        let builder = self.builder;
59        let handle = self.handle;
60        let runtime_plugins = crate::operation::list_objects_v2::ListObjectsV2::operation_runtime_plugins(
61            handle.runtime_plugins.clone(),
62            &handle.conf,
63            ::std::option::Option::None,
64        )
65        .with_operation_plugin(crate::sdk_feature_tracker::paginator::PaginatorFeatureTrackerRuntimePlugin::new());
66        ::aws_smithy_async::future::pagination_stream::PaginationStream::new(::aws_smithy_async::future::pagination_stream::fn_stream::FnStream::new(
67            move |tx| {
68                ::std::boxed::Box::pin(async move {
69                    // Build the input for the first time. If required fields are missing, this is where we'll produce an early error.
70                    let mut input = match builder
71                        .build()
72                        .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)
73                    {
74                        ::std::result::Result::Ok(input) => input,
75                        ::std::result::Result::Err(e) => {
76                            let _ = tx.send(::std::result::Result::Err(e)).await;
77                            return;
78                        }
79                    };
80                    loop {
81                        let resp = crate::operation::list_objects_v2::ListObjectsV2::orchestrate(&runtime_plugins, input.clone()).await;
82                        // If the input member is None or it was an error
83                        let done = match resp {
84                            ::std::result::Result::Ok(ref resp) => {
85                                let new_token = crate::lens::reflens_list_objects_v2_output_output_next_continuation_token(resp);
86                                // Pagination is exhausted when the next token is an empty string
87                                let is_empty = new_token.map(|token| token.is_empty()).unwrap_or(true);
88                                if !is_empty && new_token == input.continuation_token.as_ref() && self.stop_on_duplicate_token {
89                                    true
90                                } else {
91                                    input.continuation_token = new_token.cloned();
92                                    is_empty
93                                }
94                            }
95                            ::std::result::Result::Err(_) => true,
96                        };
97                        if tx.send(resp).await.is_err() {
98                            // receiving end was dropped
99                            return;
100                        }
101                        if done {
102                            return;
103                        }
104                    }
105                })
106            },
107        ))
108    }
109}
aws_sdk_s3/operation/list_objects_v2/paginator.rs

aws_sdk_s3/operation/list_objects_v2/
paginator.rs
