Struct ReadLimit 

pub struct ReadLimit {
    pub count: Option<u64>,
    pub bytes: Option<u64>,
}

Limit how many records can be retrieved. If both count and bytes are specified, either limit may be hit.

Fields

count: Option<u64>

Record count limit.

bytes: Option<u64>

Metered bytes limit.

Implementations

impl ReadLimit

pub fn new() -> Self

Create a new read limit.

Examples found in repository

examples/get_latest_record.rs (line 14)

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_count(self, count: u64) -> Self

Overwrite count limit.

Examples found in repository

examples/get_latest_record.rs (line 14)

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_bytes(self, bytes: u64) -> Self

Overwrite bytes limit.

Trait Implementations

impl Clone for ReadLimit

fn clone(&self) -> ReadLimit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReadLimit

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

Formats the value using the given formatter.

impl Default for ReadLimit

fn default() -> ReadLimit

Returns the “default value” for a type.