Struct ReadStop 

#[non_exhaustive]
pub struct ReadStop {
    pub limits: ReadLimits,
    pub until: Option<RangeTo<u64>>,
    pub wait: Option<u32>,
}

When to stop reading.

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.

limits: ReadLimits

Limits on how much to read.

until: Option<RangeTo<u64>>

Timestamp at which to stop (exclusive).

wait: Option<u32>

Duration in seconds to wait for new records before stopping. Will be clamped to 60 seconds for read.

Defaults to:

• 0 (no wait) for read.
• 0 (no wait) for read_session if limits or until is specified.
• Infinite wait for read_session if neither limits nor until is specified.

Implementations

impl ReadStop

pub fn new() -> Self

Create a new ReadStop with default values.

Examples found in repository

examples/get_latest_record.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 stream = s2.basin(basin_name).stream(stream_name);

    let input = ReadInput::new()
        .with_start(ReadStart::new().with_from(ReadFrom::TailOffset(1)))
        .with_stop(ReadStop::new().with_limits(ReadLimits::new().with_count(1)));
    let batch = stream.read(input).await?;
    println!("{batch:#?}");

    Ok(())
}

pub fn with_limits(self, limits: ReadLimits) -> Self

Set the limits on how much to read.

Examples found in repository

examples/get_latest_record.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 stream = s2.basin(basin_name).stream(stream_name);

    let input = ReadInput::new()
        .with_start(ReadStart::new().with_from(ReadFrom::TailOffset(1)))
        .with_stop(ReadStop::new().with_limits(ReadLimits::new().with_count(1)));
    let batch = stream.read(input).await?;
    println!("{batch:#?}");

    Ok(())
}

pub fn with_until(self, until: RangeTo<u64>) -> Self

Set the timestamp at which to stop (exclusive).

pub fn with_wait(self, wait: u32) -> Self

Set the duration in seconds to wait for new records before stopping.

Trait Implementations

impl Clone for ReadStop

fn clone(&self) -> ReadStop

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadStop

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

Formats the value using the given formatter.

impl Default for ReadStop

fn default() -> ReadStop

Returns the “default value” for a type.

impl From<ReadStop> for ReadEnd

fn from(value: ReadStop) -> Self

Converts to this type from the input type.