Struct DeleteBasinRequest 

pub struct DeleteBasinRequest {
    pub basin: BasinName,
    pub if_exists: bool,
}

Delete basin request.

Fields

basin: BasinName

Name of the basin to delete.

if_exists: bool

Delete basin if it exists else do nothing.

Implementations

impl DeleteBasinRequest

pub fn new(basin: BasinName) -> Self

Create a new request.

Examples found in repository

examples/delete_basin.rs (line 14)

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

    let basin: BasinName = "my-favorite-basin".parse()?;

    let delete_basin_request = DeleteBasinRequest::new(basin)
        // Don't error if the basin doesn't exist.
        .with_if_exists(true);

    client.delete_basin(delete_basin_request).await?;

    Ok(())
}

pub fn with_if_exists(self, if_exists: bool) -> Self

Overwrite the if exists parameter.

Examples found in repository

examples/delete_basin.rs (line 16)

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

    let basin: BasinName = "my-favorite-basin".parse()?;

    let delete_basin_request = DeleteBasinRequest::new(basin)
        // Don't error if the basin doesn't exist.
        .with_if_exists(true);

    client.delete_basin(delete_basin_request).await?;

    Ok(())
}

Trait Implementations

impl Clone for DeleteBasinRequest

fn clone(&self) -> DeleteBasinRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteBasinRequest

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

Formats the value using the given formatter.