Struct TimestampingConfig 

#[non_exhaustive]
pub struct TimestampingConfig {
    pub mode: Option<TimestampingMode>,
    pub uncapped: bool,
}

Configuration for timestamping behavior.

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.

mode: Option<TimestampingMode>

Timestamping mode for appends that influences how timestamps are handled.

Defaults to ClientPrefer.

uncapped: bool

Whether client-specified timestamps are allowed to exceed the arrival time.

Defaults to false (client timestamps are capped at the arrival time).

Implementations

impl TimestampingConfig

pub fn new() -> Self

Create a new TimestampingConfig with default settings.

Examples found in repository

examples/create_stream.rs (line 25)

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_mode(self, mode: TimestampingMode) -> Self

Set the timestamping mode for appends that influences how timestamps are handled.

Examples found in repository

examples/create_stream.rs (line 25)

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_uncapped(self, uncapped: bool) -> Self

Set whether client-specified timestamps are allowed to exceed the arrival time.

Trait Implementations

impl Clone for TimestampingConfig

fn clone(&self) -> TimestampingConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TimestampingConfig

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

Formats the value using the given formatter.

impl Default for TimestampingConfig

fn default() -> TimestampingConfig

Returns the “default value” for a type.

impl From<TimestampingConfig> for TimestampingConfig

fn from(value: TimestampingConfig) -> Self

Converts to this type from the input type.

impl From<TimestampingConfig> for TimestampingConfig

fn from(value: TimestampingConfig) -> Self

Converts to this type from the input type.

impl PartialEq for TimestampingConfig

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

impl Eq for TimestampingConfig

impl StructuralPartialEq for TimestampingConfig