Struct ReadRequest

pub struct ReadRequest {
    pub start_seq_num: u64,
    pub limit: ReadLimit,
}

Read request.

Fields

start_seq_num: u64

Starting sequence number (inclusive).

limit: ReadLimit

Limit on how many records can be returned upto a maximum of 1000, or 1MiB of metered bytes.

Implementations

impl ReadRequest

pub fn new(start_seq_num: u64) -> Self

Create a new request with start sequence number.

Examples found in repository

examples/get_latest_record.rs (line 26)

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 tail = stream_client.check_tail().await?;
    if tail == 0 {
        println!("Empty stream");
        return Ok(());
    }

    let latest_seq_num = tail - 1;

    let read_limit = ReadLimit {
        count: Some(1),
        bytes: None,
    };
    let read_request = ReadRequest::new(latest_seq_num).with_limit(read_limit);
    let latest_record = stream_client.read(read_request).await?;

    println!("{latest_record:#?}");

    Ok(())
}

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

Overwrite limit.

Examples found in repository

examples/get_latest_record.rs (line 26)

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 tail = stream_client.check_tail().await?;
    if tail == 0 {
        println!("Empty stream");
        return Ok(());
    }

    let latest_seq_num = tail - 1;

    let read_limit = ReadLimit {
        count: Some(1),
        bytes: None,
    };
    let read_request = ReadRequest::new(latest_seq_num).with_limit(read_limit);
    let latest_record = stream_client.read(read_request).await?;

    println!("{latest_record:#?}");

    Ok(())
}

Trait Implementations

impl Clone for ReadRequest

fn clone(&self) -> ReadRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ReadRequest

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

Formats the value using the given formatter.

impl Default for ReadRequest

fn default() -> ReadRequest

Returns the “default value” for a type.