Struct DeleteStreamInput 

#[non_exhaustive]
pub struct DeleteStreamInput {
    pub name: StreamName,
    pub ignore_not_found: bool,
}

Input of delete_stream 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: StreamName

Stream name.

ignore_not_found: bool

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

Implementations

impl DeleteStreamInput

pub fn new(name: StreamName) -> Self

Create a new DeleteStreamInput with the given stream name.

Examples found in repository

examples/delete_stream.rs (line 20)

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 stream_name: StreamName = std::env::var("S2_STREAM")
        .map_err(|_| "S2_STREAM env var not set")?
        .parse()?;

    let s2 = S2::new(S2Config::new(access_token))?;
    let basin = s2.basin(basin_name);

    let input = DeleteStreamInput::new(stream_name);
    basin.delete_stream(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 stream doesn’t exist.

Trait Implementations

impl Clone for DeleteStreamInput

fn clone(&self) -> DeleteStreamInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DeleteStreamInput

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

Formats the value using the given formatter.