Struct StreamConfig 

#[non_exhaustive]
pub struct StreamConfig {
    pub storage_class: Option<StorageClass>,
    pub retention_policy: Option<RetentionPolicy>,
    pub timestamping: Option<TimestampingConfig>,
    pub delete_on_empty: Option<DeleteOnEmptyConfig>,
}

Configuration for a stream.

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.

storage_class: Option<StorageClass>

Storage class for the stream.

Defaults to Express.

retention_policy: Option<RetentionPolicy>

Retention policy for records in the stream.

Defaults to 7 days of retention.

timestamping: Option<TimestampingConfig>

Configuration for timestamping behavior.

See TimestampingConfig for defaults.

delete_on_empty: Option<DeleteOnEmptyConfig>

Configuration for automatically deleting the stream when it becomes empty.

See DeleteOnEmptyConfig for defaults.

Implementations

impl StreamConfig

pub fn new() -> Self

Create a new StreamConfig with default settings.

Examples found in repository

examples/create_basin.rs (line 19)

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(())
}

examples/create_stream.rs (line 24)

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 = CreateStreamInput::new(stream_name.clone()).with_config(
        StreamConfig::new().with_timestamping(
            TimestampingConfig::new().with_mode(TimestampingMode::ClientRequire),
        ),
    );
    let stream_info = basin.create_stream(input).await?;
    println!("{stream_info:#?}");

    let stream_config = basin.get_stream_config(stream_name).await?;
    println!("{stream_config:#?}");

    Ok(())
}

pub fn with_storage_class(self, storage_class: StorageClass) -> Self

Set the storage class for the stream.

pub fn with_retention_policy(self, retention_policy: RetentionPolicy) -> Self

Set the retention policy for records in the stream.

Examples found in repository

examples/create_basin.rs (line 19)

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_timestamping(self, timestamping: TimestampingConfig) -> Self

Set the configuration for timestamping behavior.

Examples found in repository

examples/create_stream.rs (lines 24-26)

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 = CreateStreamInput::new(stream_name.clone()).with_config(
        StreamConfig::new().with_timestamping(
            TimestampingConfig::new().with_mode(TimestampingMode::ClientRequire),
        ),
    );
    let stream_info = basin.create_stream(input).await?;
    println!("{stream_info:#?}");

    let stream_config = basin.get_stream_config(stream_name).await?;
    println!("{stream_config:#?}");

    Ok(())
}

pub fn with_delete_on_empty(self, delete_on_empty: DeleteOnEmptyConfig) -> Self

Set the configuration for automatically deleting the stream when it becomes empty.

Trait Implementations

impl Clone for StreamConfig

fn clone(&self) -> StreamConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamConfig

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

Formats the value using the given formatter.

impl Default for StreamConfig

fn default() -> StreamConfig

Returns the “default value” for a type.

impl From<StreamConfig> for StreamConfig

fn from(value: StreamConfig) -> Self

Converts to this type from the input type.

impl From<StreamConfig> for StreamConfig

fn from(value: StreamConfig) -> Self

Converts to this type from the input type.

impl PartialEq for StreamConfig

fn eq(&self, other: &StreamConfig) -> 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 StreamConfig

impl StructuralPartialEq for StreamConfig