Struct ListStreamsRequest 

pub struct ListStreamsRequest {
    pub prefix: String,
    pub start_after: String,
    pub limit: Option<usize>,
}

List streams request.

Fields

prefix: String

List stream names that begin with this prefix.

start_after: String

Only return stream names that lexicographically start after this name. This can be the last stream name seen in a previous listing, to continue from there. It must be greater than or equal to the prefix if specified.

limit: Option<usize>

Number of results, up to a maximum of 1000.

Implementations

impl ListStreamsRequest

pub fn new() -> Self

Create a new request.

Examples found in repository

examples/list_streams.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 basin_client = BasinClient::new(config, basin);

    let prefix = "my-";
    let list_streams_request = ListStreamsRequest::new().with_prefix(prefix);

    let list_streams_response = basin_client.list_streams(list_streams_request).await?;

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

    Ok(())
}

pub fn with_prefix(self, prefix: impl Into<String>) -> Self

Overwrite prefix.

Examples found in repository

examples/list_streams.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 basin_client = BasinClient::new(config, basin);

    let prefix = "my-";
    let list_streams_request = ListStreamsRequest::new().with_prefix(prefix);

    let list_streams_response = basin_client.list_streams(list_streams_request).await?;

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

    Ok(())
}

pub fn with_start_after(self, start_after: impl Into<String>) -> Self

Overwrite start after.

pub fn with_limit(self, limit: impl Into<Option<usize>>) -> Self

Overwrite limit.

Trait Implementations

impl Clone for ListStreamsRequest

fn clone(&self) -> ListStreamsRequest

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListStreamsRequest

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

Formats the value using the given formatter.

impl Default for ListStreamsRequest

fn default() -> ListStreamsRequest

Returns the “default value” for a type.