Struct ReadSessionRequest 

pub struct ReadSessionRequest {
    pub start: ReadStart,
    pub limit: ReadLimit,
    pub until: Option<RangeTo<u64>>,
    pub clamp: bool,
}

Read session request.

Fields

start: ReadStart

Starting position for records. Retrieved batches will start at the first record whose position is greater than or equal to it.

limit: ReadLimit

Limit on how many records can be returned. When a limit is specified, the session will be terminated as soon as the limit is met, or when the current tail of the stream is reached – whichever occurs first. If no limit is specified, the session will remain open after catching up to the tail, and continue tailing as new messages are written to the stream.

until: Option<RangeTo<u64>>

Exclusive timestamp to read until. If provided, this is applied as an additional constraint on top of the limit, and will guarantee that all records returned have timestamps < the provided until.

clamp: bool

Clamp the start position at the tail position.

Implementations

impl ReadSessionRequest

pub fn new(start: ReadStart) -> Self

Create a new request with the specified starting point.

Examples found in repository

examples/consumer.rs (line 17)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_ACCESS_TOKEN")?;
    let config = ClientConfig::new(token);
    let basin: BasinName = "my-favorite-basin".parse()?;
    let stream = "my-favorite-stream";
    let stream_client = StreamClient::new(config, basin, stream);

    let start_seq_num = 0;
    let read_session_request = ReadSessionRequest::new(ReadStart::SeqNum(start_seq_num));
    let mut read_stream = stream_client.read_session(read_session_request).await?;

    loop {
        select! {
            next_batch = read_stream.next() => {
                let Some(next_batch) = next_batch else { break };
                let next_batch = next_batch?;
                println!("{next_batch:?}");
            }
            _ = tokio::signal::ctrl_c() => break,
        }
    }

    Ok(())
}

pub fn with_limit(self, limit: ReadLimit) -> Self

Overwrite limit.

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

Provide an until timestamp.

pub fn with_clamp(self, clamp: bool) -> Self

Clamp the start position at the tail position.

Trait Implementations

impl Clone for ReadSessionRequest

fn clone(&self) -> ReadSessionRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadSessionRequest

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

Formats the value using the given formatter.

impl Default for ReadSessionRequest

fn default() -> ReadSessionRequest

Returns the “default value” for a type.