s2::types

Struct ListBasinsRequest

pub struct ListBasinsRequest {
    pub prefix: String,
    pub start_after: String,
    pub limit: Option<usize>,
}

👎Deprecated since 0.21.1:

This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

Expand description

List basins request.

Fields§

§prefix: String

👎Deprecated since 0.21.1:

This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

List basin names that begin with this prefix.

§start_after: String

👎Deprecated since 0.21.1:

This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

Only return basins names that lexicographically start after this name. This can be the last basin name seen in a previous listing, to continue from there. It must be greater than or equal to the prefix if specified.

§limit: Option<usize>

👎Deprecated since 0.21.1:

This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

Number of results, up to a maximum of 1000.

Implementations§

Source §

impl ListBasinsRequest

Source

pub fn new() -> Self

👎Deprecated since 0.21.1:

This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

Create a new request.

Examples found in repository ?

examples/list_all_basins.rs (line 18)

7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8    let token = std::env::var("S2_ACCESS_TOKEN")?;
9    let config = ClientConfig::new(token);
10    let client = Client::new(config);
11
12    let mut all_basins = Vec::new();
13
14    let mut has_more = true;
15    let mut start_after: Option<String> = None;
16
17    while has_more {
18        let mut list_basins_request = ListBasinsRequest::new();
19        if let Some(start_after) = start_after.take() {
20            list_basins_request = list_basins_request.with_start_after(start_after);
21        }
22
23        let list_basins_response = client.list_basins(list_basins_request).await?;
24
25        all_basins.extend(list_basins_response.basins);
26
27        start_after = all_basins.last().map(|b| b.name.clone());
28        has_more = list_basins_response.has_more;
29    }
30
31    println!("{all_basins:#?}");
32
33    Ok(())
34}

Source

pub fn with_prefix(self, prefix: impl Into<String>) -> Self

👎Deprecated since 0.21.1:

This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

Overwrite prefix.

Source

pub fn with_start_after(self, start_after: impl Into<String>) -> Self

👎Deprecated since 0.21.1:

This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

Overwrite start after.

Examples found in repository ?

examples/list_all_basins.rs (line 20)

7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8    let token = std::env::var("S2_ACCESS_TOKEN")?;
9    let config = ClientConfig::new(token);
10    let client = Client::new(config);
11
12    let mut all_basins = Vec::new();
13
14    let mut has_more = true;
15    let mut start_after: Option<String> = None;
16
17    while has_more {
18        let mut list_basins_request = ListBasinsRequest::new();
19        if let Some(start_after) = start_after.take() {
20            list_basins_request = list_basins_request.with_start_after(start_after);
21        }
22
23        let list_basins_response = client.list_basins(list_basins_request).await?;
24
25        all_basins.extend(list_basins_response.basins);
26
27        start_after = all_basins.last().map(|b| b.name.clone());
28        has_more = list_basins_response.has_more;
29    }
30
31    println!("{all_basins:#?}");
32
33    Ok(())
34}