s2::types

Struct ReadRequest

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

👎Deprecated since 0.21.1: This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

Expand description

Read request.

Fields§

§start: ReadStart

👎Deprecated since 0.21.1: This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

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

§limit: ReadLimit

👎Deprecated since 0.21.1: This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

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>>

👎Deprecated since 0.21.1: This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

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

👎Deprecated since 0.21.1: This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

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§

Source §

impl ReadRequest

Source

pub fn new(start: ReadStart) -> Self

👎Deprecated since 0.21.1: This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

Create a new request with the specified starting point.

Examples found in repository ?

examples/get_latest_record.rs (line 15)

7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8    let token = std::env::var("S2_ACCESS_TOKEN")?;
9    let config = ClientConfig::new(token);
10    let basin: BasinName = "my-favorite-basin".parse()?;
11    let stream = "my-favorite-stream";
12    let stream_client = StreamClient::new(config, basin, stream);
13
14    let read_limit = ReadLimit::new().with_count(1);
15    let read_request = ReadRequest::new(ReadStart::TailOffset(1)).with_limit(read_limit);
16    let latest_record = stream_client.read(read_request).await?;
17
18    println!("{latest_record:#?}");
19
20    Ok(())
21}

Source

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

👎Deprecated since 0.21.1: This crate has been renamed to s2-sdk. Please update your Cargo.toml to use s2-sdk instead.

Overwrite limit.

Examples found in repository ?

examples/get_latest_record.rs (line 15)

7async fn main() -> Result<(), Box<dyn std::error::Error>> {
8    let token = std::env::var("S2_ACCESS_TOKEN")?;
9    let config = ClientConfig::new(token);
10    let basin: BasinName = "my-favorite-basin".parse()?;
11    let stream = "my-favorite-stream";
12    let stream_client = StreamClient::new(config, basin, stream);
13
14    let read_limit = ReadLimit::new().with_count(1);
15    let read_request = ReadRequest::new(ReadStart::TailOffset(1)).with_limit(read_limit);
16    let latest_record = stream_client.read(read_request).await?;
17
18    println!("{latest_record:#?}");
19
20    Ok(())
21}