Struct DeleteBasinInput 

#[non_exhaustive]
pub struct DeleteBasinInput {
    pub name: BasinName,
    pub ignore_not_found: bool,
}

Input for delete_basin operation.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: BasinName

Basin name.

ignore_not_found: bool

Whether to ignore Not Found error if the basin doesn’t exist.

Implementations

impl DeleteBasinInput

pub fn new(name: BasinName) -> Self

Create a new DeleteBasinInput with the given basin name.

Examples found in repository

examples/delete_basin.rs (line 17)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let access_token =
        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
    let basin_name: BasinName = std::env::var("S2_BASIN")
        .map_err(|_| "S2_BASIN env var not set")?
        .parse()?;

    let config = S2Config::new(access_token);
    let s2 = S2::new(config)?;

    let input = DeleteBasinInput::new(basin_name).with_ignore_not_found(true);
    s2.delete_basin(input).await?;
    println!("Deletion requested");

    Ok(())
}

pub fn with_ignore_not_found(self, ignore_not_found: bool) -> Self

Set whether to ignore Not Found error if the basin is not existing.

Examples found in repository

examples/delete_basin.rs (line 17)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let access_token =
        std::env::var("S2_ACCESS_TOKEN").map_err(|_| "S2_ACCESS_TOKEN env var not set")?;
    let basin_name: BasinName = std::env::var("S2_BASIN")
        .map_err(|_| "S2_BASIN env var not set")?
        .parse()?;

    let config = S2Config::new(access_token);
    let s2 = S2::new(config)?;

    let input = DeleteBasinInput::new(basin_name).with_ignore_not_found(true);
    s2.delete_basin(input).await?;
    println!("Deletion requested");

    Ok(())
}

Trait Implementations

impl Clone for DeleteBasinInput

fn clone(&self) -> DeleteBasinInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteBasinInput

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

Formats the value using the given formatter.