Struct BasinConfig 

#[non_exhaustive]
pub struct BasinConfig {
    pub default_stream_config: Option<StreamConfig>,
    pub stream_cipher: Option<EncryptionAlgorithm>,
    pub create_stream_on_append: bool,
    pub create_stream_on_read: bool,
}

Configuration for a basin.

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: Option<StreamConfig>

Default configuration for all streams in the basin.

See StreamConfig for defaults.

stream_cipher: Option<EncryptionAlgorithm>

Encryption algorithm to apply to newly created streams in the basin.

create_stream_on_append: bool

Whether to create stream on append if it doesn’t exist using default stream configuration.

Defaults to false.

create_stream_on_read: bool

Whether to create stream on read if it doesn’t exist using default stream configuration.

Defaults to false.

Implementations

impl BasinConfig

pub fn new() -> Self

Create a new BasinConfig with default settings.

Examples found in repository

examples/create_basin.rs (line 18)

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 = CreateBasinInput::new(basin_name.clone()).with_config(
        BasinConfig::new().with_default_stream_config(
            StreamConfig::new().with_retention_policy(RetentionPolicy::Age(10 * 24 * 60 * 60)),
        ),
    );
    let basin_info = s2.create_basin(input).await?;
    println!("{basin_info:#?}");

    let basin_config = s2.get_basin_config(basin_name).await?;
    println!("{basin_config:#?}");

    Ok(())
}

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

Set the default configuration for all streams in the basin.

Examples found in repository

examples/create_basin.rs (lines 18-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 config = S2Config::new(access_token);
    let s2 = S2::new(config)?;

    let input = CreateBasinInput::new(basin_name.clone()).with_config(
        BasinConfig::new().with_default_stream_config(
            StreamConfig::new().with_retention_policy(RetentionPolicy::Age(10 * 24 * 60 * 60)),
        ),
    );
    let basin_info = s2.create_basin(input).await?;
    println!("{basin_info:#?}");

    let basin_config = s2.get_basin_config(basin_name).await?;
    println!("{basin_config:#?}");

    Ok(())
}

pub fn with_stream_cipher(self, stream_cipher: EncryptionAlgorithm) -> Self

Set the encryption algorithm to apply to newly created streams in the basin.

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

Set whether to create stream on append if it doesn’t exist using default stream configuration.

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

Set whether to create stream on read if it doesn’t exist using default stream configuration.

Trait Implementations

impl Clone for BasinConfig

fn clone(&self) -> BasinConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BasinConfig

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

Formats the value using the given formatter.

impl Default for BasinConfig

fn default() -> BasinConfig

Returns the “default value” for a type.

impl From<BasinConfig> for BasinConfig

fn from(value: BasinConfig) -> Self

Converts to this type from the input type.

impl From<BasinConfig> for BasinConfig

fn from(value: BasinConfig) -> Self

Converts to this type from the input type.

impl PartialEq for BasinConfig

fn eq(&self, other: &BasinConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for BasinConfig

impl StructuralPartialEq for BasinConfig