Struct ReadRequest 

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

Read 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 how many records can be returned. This will get capped at the default limit, which is up to 1000 records or 1MiB of metered bytes.

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. If set, the read will start at the tail of the stream if the requested position is greater than it.

Implementations

impl ReadRequest

pub fn new(start: ReadStart) -> Self

Create a new request with the specified starting point.

Examples found in repository

examples/get_latest_record.rs (line 15)

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 read_limit = ReadLimit::new().with_count(1);
    let read_request = ReadRequest::new(ReadStart::TailOffset(1)).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 15)

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 read_limit = ReadLimit::new().with_count(1);
    let read_request = ReadRequest::new(ReadStart::TailOffset(1)).with_limit(read_limit);
    let latest_record = stream_client.read(read_request).await?;

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

    Ok(())
}

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 ReadRequest

fn clone(&self) -> ReadRequest

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