Struct ListBasinsRequest

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

List basins request.

Fields

prefix: String

List basin names that begin with this prefix.

start_after: String

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>

Number of results, up to a maximum of 1000.

Implementations

impl ListBasinsRequest

pub fn new() -> Self

Create a new request.

Examples found in repository

examples/list_all_basins.rs (line 18)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_AUTH_TOKEN")?;
    let config = ClientConfig::new(token);
    let client = Client::new(config);

    let mut all_basins = Vec::new();

    let mut has_more = true;
    let mut start_after: Option<String> = None;

    while has_more {
        let mut list_basins_request = ListBasinsRequest::new();
        if let Some(start_after) = start_after.take() {
            list_basins_request = list_basins_request.with_start_after(start_after);
        }

        let list_basins_response = client.list_basins(list_basins_request).await?;

        all_basins.extend(list_basins_response.basins);

        start_after = all_basins.last().map(|b| b.name.clone());
        has_more = list_basins_response.has_more;
    }

    println!("{all_basins:#?}");

    Ok(())
}

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

Overwrite prefix.

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

Overwrite start after.

Examples found in repository

examples/list_all_basins.rs (line 20)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_AUTH_TOKEN")?;
    let config = ClientConfig::new(token);
    let client = Client::new(config);

    let mut all_basins = Vec::new();

    let mut has_more = true;
    let mut start_after: Option<String> = None;

    while has_more {
        let mut list_basins_request = ListBasinsRequest::new();
        if let Some(start_after) = start_after.take() {
            list_basins_request = list_basins_request.with_start_after(start_after);
        }

        let list_basins_response = client.list_basins(list_basins_request).await?;

        all_basins.extend(list_basins_response.basins);

        start_after = all_basins.last().map(|b| b.name.clone());
        has_more = list_basins_response.has_more;
    }

    println!("{all_basins:#?}");

    Ok(())
}

pub fn with_limit(self, limit: impl Into<Option<usize>>) -> Self

Overwrite limit.

Trait Implementations

impl Clone for ListBasinsRequest

fn clone(&self) -> ListBasinsRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ListBasinsRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ListBasinsRequest

fn default() -> ListBasinsRequest

Returns the “default value” for a type.