Struct ReadStart 

#[non_exhaustive]
pub struct ReadStart {
    pub from: ReadFrom,
    pub clamp_to_tail: bool,
}

Where to start 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.

from: ReadFrom

Starting position.

Defaults to reading from sequence number 0.

clamp_to_tail: bool

Whether to start from tail if the requested starting position is beyond it.

Defaults to false (errors if position is beyond tail).

Implementations

impl ReadStart

pub fn new() -> Self

Create a new ReadStart with default values.

Examples found in repository

examples/get_latest_record.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 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_from(self, from: ReadFrom) -> Self

Set the starting position.

Examples found in repository

examples/get_latest_record.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 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_clamp_to_tail(self, clamp_to_tail: bool) -> Self

Set whether to start from tail if the requested starting position is beyond it.

Trait Implementations

impl Clone for ReadStart

fn clone(&self) -> ReadStart

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadStart

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

Formats the value using the given formatter.

impl Default for ReadStart

fn default() -> ReadStart

Returns the “default value” for a type.

impl From<ReadStart> for ReadStart

fn from(value: ReadStart) -> Self

Converts to this type from the input type.