Struct CreateStreamInput 

#[non_exhaustive]
pub struct CreateStreamInput {
    pub name: StreamName,
    pub config: Option<StreamConfig>,
    pub idempotency_token: String,
}

Input for create_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.

config: Option<StreamConfig>

Configuration for the stream.

See StreamConfig for defaults.

idempotency_token: String

Idempotency token for the operation.

When a request is retried, the same token is reused, causing the server to return the original response instead of performing the operation again.

Defaults to a random UUID.

Implementations

impl CreateStreamInput

pub fn new(name: StreamName) -> Self

Create a new CreateStreamInput with the given stream name.

Examples found in repository

examples/create_stream.rs (line 23)

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_config(self, config: StreamConfig) -> Self

Set the configuration for the stream.

Examples found in repository

examples/create_stream.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 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_idempotency_token( self, idempotency_token: impl Into<String>, ) -> Self

Set the idempotency token for the operation.

Trait Implementations

impl Clone for CreateStreamInput

fn clone(&self) -> CreateStreamInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateStreamInput

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

Formats the value using the given formatter.

impl From<CreateStreamInput> for (CreateStreamRequest, String)

fn from(value: CreateStreamInput) -> Self

Converts to this type from the input type.