Struct BasinReconfiguration 

#[non_exhaustive]
pub struct BasinReconfiguration {
    pub default_stream_config: Maybe<Option<StreamReconfiguration>>,
    pub create_stream_on_append: Maybe<bool>,
    pub create_stream_on_read: Maybe<bool>,
}

Reconfiguration for BasinConfig.

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.

default_stream_config: Maybe<Option<StreamReconfiguration>>

Override for the existing default_stream_config.

create_stream_on_append: Maybe<bool>

Override for the existing create_stream_on_append.

create_stream_on_read: Maybe<bool>

Override for the existing create_stream_on_read.

Implementations

impl BasinReconfiguration

pub fn new() -> Self

Create a new BasinReconfiguration.

Examples found in repository

examples/reconfigure_basin.rs (line 22)

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 = ReconfigureBasinInput::new(
        basin_name,
        BasinReconfiguration::new()
            .with_default_stream_config(
                StreamReconfiguration::new()
                    .with_storage_class(StorageClass::Standard)
                    .with_timestamping(TimestampingReconfiguration::new().with_uncapped(true)),
            )
            .with_create_stream_on_read(true),
    );
    let config = s2.reconfigure_basin(input).await?;
    println!("{config:#?}");

    Ok(())
}

pub fn with_default_stream_config(self, config: StreamReconfiguration) -> Self

Set the override for the existing default_stream_config.

Examples found in repository

examples/reconfigure_basin.rs (lines 23-27)

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 = ReconfigureBasinInput::new(
        basin_name,
        BasinReconfiguration::new()
            .with_default_stream_config(
                StreamReconfiguration::new()
                    .with_storage_class(StorageClass::Standard)
                    .with_timestamping(TimestampingReconfiguration::new().with_uncapped(true)),
            )
            .with_create_stream_on_read(true),
    );
    let config = s2.reconfigure_basin(input).await?;
    println!("{config:#?}");

    Ok(())
}

pub fn with_create_stream_on_append(self, create_stream_on_append: bool) -> Self

Set the override for the existing create_stream_on_append.

pub fn with_create_stream_on_read(self, create_stream_on_read: bool) -> Self

Set the override for the existing create_stream_on_read.

Examples found in repository

examples/reconfigure_basin.rs (line 28)

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 = ReconfigureBasinInput::new(
        basin_name,
        BasinReconfiguration::new()
            .with_default_stream_config(
                StreamReconfiguration::new()
                    .with_storage_class(StorageClass::Standard)
                    .with_timestamping(TimestampingReconfiguration::new().with_uncapped(true)),
            )
            .with_create_stream_on_read(true),
    );
    let config = s2.reconfigure_basin(input).await?;
    println!("{config:#?}");

    Ok(())
}

Trait Implementations

impl Clone for BasinReconfiguration

fn clone(&self) -> BasinReconfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BasinReconfiguration

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

Formats the value using the given formatter.

impl Default for BasinReconfiguration

fn default() -> BasinReconfiguration

Returns the “default value” for a type.

impl From<BasinReconfiguration> for BasinReconfiguration

fn from(value: BasinReconfiguration) -> Self

Converts to this type from the input type.