Struct ReadSessionRequest

pub struct ReadSessionRequest {
    pub start_seq_num: u64,
    pub limit: Option<ReadLimit>,
}

Read session request.

Fields

start_seq_num: u64

Starting sequence number (inclusive).

limit: Option<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.

Implementations

impl ReadSessionRequest

pub fn new(start_seq_num: u64) -> Self

Create a new request with start sequene number.

Examples found in repository

examples/consumer.rs (line 17)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let token = std::env::var("S2_AUTH_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(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.

Trait Implementations

impl Clone for ReadSessionRequest

fn clone(&self) -> ReadSessionRequest

Returns a copy 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.